Xurrent.GraphQL.PowerShell.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-XurrentCustomField</command:name> <command:verb>Add</command:verb> <command:noun>XurrentCustomField</command:noun> <command:description> <maml:para>A PowerShell cmdlet to add or update a custom field value. If the custom field identifier already exists, it will be assigned a new value; otherwise, it gets created.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Add-XurrentCustomField cmdlet adds or updates a custom field value.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Add-XurrentCustomField</maml:name> <command:parameter required="true" position="0"> <maml:name>CustomFieldCollection</maml:name> <maml:description> <maml:para>The custom field collection to add the new custom field to.</maml:para> </maml:description> <command:parameterValue required="true">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>The custom field identifier.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>The custom field value.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>CustomFieldCollection</maml:name> <maml:description> <maml:para>The custom field collection to add the new custom field to.</maml:para> </maml:description> <command:parameterValue required="true">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ID</maml:name> <maml:description> <maml:para>The custom field identifier.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>The custom field value.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>The Custom field collection.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>The Custom Field Collection with the new or updated item.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentAccountQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentAccountQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking an account query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentAccountQuery cmdlet executes the provided New-XurrentAccountQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentAccountQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The account query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The account query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Account</maml:name> </dev:type> <maml:description> <maml:para>An Account object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentAffectedSlaQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentAffectedSlaQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking an affected service level agreement query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentAffectedSlaQuery cmdlet executes the provided New-XurrentAffectedSlaQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentAffectedSlaQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The affected service level agreement query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AffectedSlaQuery</command:parameterValue> <dev:type> <maml:name>AffectedSlaQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The affected service level agreement query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AffectedSlaQuery</command:parameterValue> <dev:type> <maml:name>AffectedSlaQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AffectedSlaQuery</maml:name> </dev:type> <maml:description> <maml:para>An affected service level agreement query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AffectedSla[]</maml:name> </dev:type> <maml:description> <maml:para>An array of AffectedSla objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentAgileBoardQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentAgileBoardQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking an agile board query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentAgileBoardQuery cmdlet executes the provided New-XurrentAgileBoardQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentAgileBoardQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The agile board query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The agile board query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AgileBoard[]</maml:name> </dev:type> <maml:description> <maml:para>An array of AgileBoard objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentAppInstanceQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentAppInstanceQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking an app instance query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentAppInstanceQuery cmdlet executes the provided New-XurrentAppInstanceQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentAppInstanceQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The app instance query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AppInstanceQuery</command:parameterValue> <dev:type> <maml:name>AppInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The app instance query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AppInstanceQuery</command:parameterValue> <dev:type> <maml:name>AppInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>An app instance query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AppInstance[]</maml:name> </dev:type> <maml:description> <maml:para>An array of AppInstance objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentAppOfferingQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentAppOfferingQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking an app offering query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentAppOfferingQuery cmdlet executes the provided New-XurrentAppOfferingQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentAppOfferingQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The app offering query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AppOfferingQuery</command:parameterValue> <dev:type> <maml:name>AppOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The app offering query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AppOfferingQuery</command:parameterValue> <dev:type> <maml:name>AppOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>An app offering query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AppOffering[]</maml:name> </dev:type> <maml:description> <maml:para>An array of AppOffering objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentArchiveQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentArchiveQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking an archive query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentArchiveQuery cmdlet executes the provided New-XurrentArchiveQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentArchiveQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The archive query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ArchiveQuery</command:parameterValue> <dev:type> <maml:name>ArchiveQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The archive query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ArchiveQuery</command:parameterValue> <dev:type> <maml:name>ArchiveQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ArchiveQuery</maml:name> </dev:type> <maml:description> <maml:para>An archive query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Archive[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Archive objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentAttachmentStorageQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentAttachmentStorageQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking an attachment storage query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentAttachmentStorageQuery cmdlet executes the provided New-XurrentAttachmentStorageQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentAttachmentStorageQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The attachment storage query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AttachmentStorageQuery</command:parameterValue> <dev:type> <maml:name>AttachmentStorageQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The attachment storage query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AttachmentStorageQuery</command:parameterValue> <dev:type> <maml:name>AttachmentStorageQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentStorageQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment storage query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AttachmentStorage[]</maml:name> </dev:type> <maml:description> <maml:para>An array of AttachmentStorage objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentAutomationRuleQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentAutomationRuleQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking an automation rule query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentAutomationRuleQuery cmdlet executes the provided New-XurrentAutomationRuleQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentAutomationRuleQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The automation rule query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The automation rule query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AutomationRule[]</maml:name> </dev:type> <maml:description> <maml:para>An array of AutomationRule objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentBroadcastQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentBroadcastQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a broadcast query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentBroadcastQuery cmdlet executes the provided New-XurrentBroadcastQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentBroadcastQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The broadcast query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">BroadcastQuery</command:parameterValue> <dev:type> <maml:name>BroadcastQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The broadcast query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">BroadcastQuery</command:parameterValue> <dev:type> <maml:name>BroadcastQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.BroadcastQuery</maml:name> </dev:type> <maml:description> <maml:para>A broadcast query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Broadcast[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Broadcast objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentCalendarQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentCalendarQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a calendar query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentCalendarQuery cmdlet executes the provided New-XurrentCalendarQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentCalendarQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The calendar query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The calendar query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Calendar[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Calendar objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentConfigurationItemQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentConfigurationItemQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a configuration item query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentConfigurationItemQuery cmdlet executes the provided New-XurrentConfigurationItemQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentConfigurationItemQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The configuration item query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The configuration item query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ConfigurationItem[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ConfigurationItem objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentContractQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentContractQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a contract query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentContractQuery cmdlet executes the provided New-XurrentContractQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentContractQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The contract query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ContractQuery</command:parameterValue> <dev:type> <maml:name>ContractQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The contract query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ContractQuery</command:parameterValue> <dev:type> <maml:name>ContractQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContractQuery</maml:name> </dev:type> <maml:description> <maml:para>A contract query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Contract[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Contract objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentCustomCollectionElementQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentCustomCollectionElementQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a custom collection element query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentCustomCollectionElementQuery cmdlet executes the provided New-XurrentCustomCollectionElementQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentCustomCollectionElementQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The custom collection element query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">CustomCollectionElementQuery</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The custom collection element query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">CustomCollectionElementQuery</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionElementQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom collection element query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomCollectionElement[]</maml:name> </dev:type> <maml:description> <maml:para>An array of CustomCollectionElement objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentCustomCollectionQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentCustomCollectionQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a custom collection query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentCustomCollectionQuery cmdlet executes the provided New-XurrentCustomCollectionQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentCustomCollectionQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The custom collection query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">CustomCollectionQuery</command:parameterValue> <dev:type> <maml:name>CustomCollectionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The custom collection query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">CustomCollectionQuery</command:parameterValue> <dev:type> <maml:name>CustomCollectionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom collection query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomCollection[]</maml:name> </dev:type> <maml:description> <maml:para>An array of CustomCollection objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentEffortClassQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentEffortClassQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking an effort class query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentEffortClassQuery cmdlet executes the provided New-XurrentEffortClassQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentEffortClassQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The effort class query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The effort class query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>EffortClass[]</maml:name> </dev:type> <maml:description> <maml:para>An array of EffortClass objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentFirstLineSupportAgreementQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentFirstLineSupportAgreementQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a first line support agreement query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentFirstLineSupportAgreementQuery cmdlet executes the provided New-XurrentFirstLineSupportAgreementQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentFirstLineSupportAgreementQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The first line support agreement query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">FirstLineSupportAgreementQuery</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The first line support agreement query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">FirstLineSupportAgreementQuery</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FirstLineSupportAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A first line support agreement query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>FirstLineSupportAgreement[]</maml:name> </dev:type> <maml:description> <maml:para>An array of FirstLineSupportAgreement objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentHolidayQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentHolidayQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a holiday query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentHolidayQuery cmdlet executes the provided New-XurrentHolidayQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentHolidayQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The holiday query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">HolidayQuery</command:parameterValue> <dev:type> <maml:name>HolidayQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The holiday query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">HolidayQuery</command:parameterValue> <dev:type> <maml:name>HolidayQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.HolidayQuery</maml:name> </dev:type> <maml:description> <maml:para>A holiday query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Holiday[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Holiday objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentInvoiceQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentInvoiceQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking an invoice query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentInvoiceQuery cmdlet executes the provided New-XurrentInvoiceQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentInvoiceQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The invoice query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The invoice query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InvoiceQuery</maml:name> </dev:type> <maml:description> <maml:para>An invoice query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Invoice[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Invoice objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentKnowledgeArticleQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentKnowledgeArticleQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a knowledge article query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentKnowledgeArticleQuery cmdlet executes the provided New-XurrentKnowledgeArticleQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentKnowledgeArticleQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The knowledge article query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">KnowledgeArticleQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The knowledge article query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">KnowledgeArticleQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleQuery</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>KnowledgeArticle[]</maml:name> </dev:type> <maml:description> <maml:para>An array of KnowledgeArticle objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentKnowledgeArticleTemplateQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentKnowledgeArticleTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a knowledge article template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentKnowledgeArticleTemplateQuery cmdlet executes the provided New-XurrentKnowledgeArticleTemplateQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentKnowledgeArticleTemplateQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The knowledge article template query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">KnowledgeArticleTemplateQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The knowledge article template query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">KnowledgeArticleTemplateQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article template query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>KnowledgeArticleTemplate[]</maml:name> </dev:type> <maml:description> <maml:para>An array of KnowledgeArticleTemplate objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentMeQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentMeQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a person query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentMeQuery cmdlet executes the provided New-XurrentPersonQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentMeQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The person query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">MeQuery</command:parameterValue> <dev:type> <maml:name>MeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The person query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">MeQuery</command:parameterValue> <dev:type> <maml:name>MeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.MeQuery</maml:name> </dev:type> <maml:description> <maml:para>A me query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Person</maml:name> </dev:type> <maml:description> <maml:para>A Person object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentOrganizationQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentOrganizationQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking an organization query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentOrganizationQuery cmdlet executes the provided New-XurrentOrganizationQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentOrganizationQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The organization query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The organization query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Organization[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Organization objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentOutOfOfficePeriodQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentOutOfOfficePeriodQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking an out of office period query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentOutOfOfficePeriodQuery cmdlet executes the provided New-XurrentOutOfOfficePeriodQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentOutOfOfficePeriodQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The out of office period query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">OutOfOfficePeriodQuery</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The out of office period query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">OutOfOfficePeriodQuery</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OutOfOfficePeriodQuery</maml:name> </dev:type> <maml:description> <maml:para>An out of office period query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OutOfOfficePeriod[]</maml:name> </dev:type> <maml:description> <maml:para>An array of OutOfOfficePeriod objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentPdfDesignQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentPdfDesignQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a pdf design query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentPdfDesignQuery cmdlet executes the provided New-XurrentPdfDesignQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentPdfDesignQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The pdf design query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">PdfDesignQuery</command:parameterValue> <dev:type> <maml:name>PdfDesignQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The pdf design query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">PdfDesignQuery</command:parameterValue> <dev:type> <maml:name>PdfDesignQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PdfDesignQuery</maml:name> </dev:type> <maml:description> <maml:para>A pdf design query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PdfDesign[]</maml:name> </dev:type> <maml:description> <maml:para>An array of PdfDesign objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentPersonQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentPersonQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a person query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentPersonQuery cmdlet executes the provided New-XurrentPersonQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentPersonQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The person query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The person query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Person[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Person objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentProblemQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentProblemQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a problem query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentProblemQuery cmdlet executes the provided New-XurrentProblemQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentProblemQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The problem query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The problem query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemQuery</maml:name> </dev:type> <maml:description> <maml:para>A problem query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Problem[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Problem objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentProductBacklogQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentProductBacklogQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a product backlog query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentProductBacklogQuery cmdlet executes the provided New-XurrentProductBacklogQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentProductBacklogQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The product backlog query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProductBacklogQuery</command:parameterValue> <dev:type> <maml:name>ProductBacklogQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The product backlog query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProductBacklogQuery</command:parameterValue> <dev:type> <maml:name>ProductBacklogQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductBacklogQuery</maml:name> </dev:type> <maml:description> <maml:para>A product backlog query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProductBacklog[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ProductBacklog objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentProductCategoryQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentProductCategoryQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a product category query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentProductCategoryQuery cmdlet executes the provided New-XurrentProductCategoryQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentProductCategoryQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The product category query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProductCategoryQuery</command:parameterValue> <dev:type> <maml:name>ProductCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The product category query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProductCategoryQuery</command:parameterValue> <dev:type> <maml:name>ProductCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A product category query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProductCategory[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ProductCategory objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentProductQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentProductQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a product query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentProductQuery cmdlet executes the provided New-XurrentProductQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentProductQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The product query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProductQuery</command:parameterValue> <dev:type> <maml:name>ProductQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The product query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProductQuery</command:parameterValue> <dev:type> <maml:name>ProductQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductQuery</maml:name> </dev:type> <maml:description> <maml:para>A product query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Product[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Product objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentProjectCategoryQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentProjectCategoryQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a project category query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentProjectCategoryQuery cmdlet executes the provided New-XurrentProjectCategoryQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentProjectCategoryQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The project category query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProjectCategoryQuery</command:parameterValue> <dev:type> <maml:name>ProjectCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The project category query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProjectCategoryQuery</command:parameterValue> <dev:type> <maml:name>ProjectCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A project category query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectCategory[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ProjectCategory objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentProjectQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentProjectQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a project query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentProjectQuery cmdlet executes the provided New-XurrentProjectQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentProjectQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The project query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The project query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectQuery</maml:name> </dev:type> <maml:description> <maml:para>A project query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Project[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Project objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentProjectRiskLevelQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentProjectRiskLevelQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a project risk level query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentProjectRiskLevelQuery cmdlet executes the provided New-XurrentProjectRiskLevelQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentProjectRiskLevelQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The project risk level query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProjectRiskLevelQuery</command:parameterValue> <dev:type> <maml:name>ProjectRiskLevelQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The project risk level query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProjectRiskLevelQuery</command:parameterValue> <dev:type> <maml:name>ProjectRiskLevelQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectRiskLevelQuery</maml:name> </dev:type> <maml:description> <maml:para>A project risk level query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectRiskLevel[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ProjectRiskLevel objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentProjectTaskQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentProjectTaskQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a project task query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentProjectTaskQuery cmdlet executes the provided New-XurrentProjectTaskQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentProjectTaskQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The project task query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The project task query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTask[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ProjectTask objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentProjectTaskTemplateQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentProjectTaskTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a project task template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentProjectTaskTemplateQuery cmdlet executes the provided New-XurrentProjectTaskTemplateQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentProjectTaskTemplateQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The project task template query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The project task template query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task template query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTaskTemplate[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ProjectTaskTemplate objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentProjectTemplateQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentProjectTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a project template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentProjectTemplateQuery cmdlet executes the provided New-XurrentProjectTemplateQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentProjectTemplateQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The project template query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTemplateQuery</command:parameterValue> <dev:type> <maml:name>ProjectTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The project template query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTemplateQuery</command:parameterValue> <dev:type> <maml:name>ProjectTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A project template query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTemplate[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ProjectTemplate objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentRateLimitQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentRateLimitQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a rate limit query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentRateLimitQuery cmdlet executes the provided New-XurrentRateLimitQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentRateLimitQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The rate limit query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">RateLimitQuery</command:parameterValue> <dev:type> <maml:name>RateLimitQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The rate limit query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">RateLimitQuery</command:parameterValue> <dev:type> <maml:name>RateLimitQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RateLimitQuery</maml:name> </dev:type> <maml:description> <maml:para>A rate limit query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RateLimit</maml:name> </dev:type> <maml:description> <maml:para>A RateLimit object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentReleaseQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentReleaseQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a release query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentReleaseQuery cmdlet executes the provided New-XurrentReleaseQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentReleaseQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The release query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ReleaseQuery</command:parameterValue> <dev:type> <maml:name>ReleaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The release query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ReleaseQuery</command:parameterValue> <dev:type> <maml:name>ReleaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReleaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A release query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Release[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Release objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentRequestQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentRequestQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a request query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentRequestQuery cmdlet executes the provided New-XurrentRequestQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentRequestQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The request query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The request query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Request[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Request objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentRequestTemplateQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentRequestTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a request template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentRequestTemplateQuery cmdlet executes the provided New-XurrentRequestTemplateQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentRequestTemplateQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The request template query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The request template query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A request template query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RequestTemplate[]</maml:name> </dev:type> <maml:description> <maml:para>An array of RequestTemplate objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentReservationOfferingQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentReservationOfferingQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a reservation offering query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentReservationOfferingQuery cmdlet executes the provided New-XurrentReservationOfferingQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentReservationOfferingQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The reservation offering query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ReservationOfferingQuery</command:parameterValue> <dev:type> <maml:name>ReservationOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The reservation offering query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ReservationOfferingQuery</command:parameterValue> <dev:type> <maml:name>ReservationOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>A reservation offering query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ReservationOffering[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ReservationOffering objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentReservationQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentReservationQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a reservation query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentReservationQuery cmdlet executes the provided New-XurrentReservationQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentReservationQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The reservation query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ReservationQuery</command:parameterValue> <dev:type> <maml:name>ReservationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The reservation query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ReservationQuery</command:parameterValue> <dev:type> <maml:name>ReservationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationQuery</maml:name> </dev:type> <maml:description> <maml:para>A reservation query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Reservation[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Reservation objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentRiskQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentRiskQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a risk query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentRiskQuery cmdlet executes the provided New-XurrentRiskQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentRiskQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The risk query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">RiskQuery</command:parameterValue> <dev:type> <maml:name>RiskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The risk query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">RiskQuery</command:parameterValue> <dev:type> <maml:name>RiskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskQuery</maml:name> </dev:type> <maml:description> <maml:para>A risk query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Risk[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Risk objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentRiskSeverityQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentRiskSeverityQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a risk severity query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentRiskSeverityQuery cmdlet executes the provided New-XurrentRiskSeverityQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentRiskSeverityQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The risk severity query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">RiskSeverityQuery</command:parameterValue> <dev:type> <maml:name>RiskSeverityQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The risk severity query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">RiskSeverityQuery</command:parameterValue> <dev:type> <maml:name>RiskSeverityQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskSeverityQuery</maml:name> </dev:type> <maml:description> <maml:para>A risk severity query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RiskSeverity[]</maml:name> </dev:type> <maml:description> <maml:para>An array of RiskSeverity objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentScrumWorkspaceQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentScrumWorkspaceQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a scrum workspace query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentScrumWorkspaceQuery cmdlet executes the provided New-XurrentScrumWorkspaceQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentScrumWorkspaceQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The scrum workspace query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ScrumWorkspaceQuery</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The scrum workspace query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ScrumWorkspaceQuery</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ScrumWorkspaceQuery</maml:name> </dev:type> <maml:description> <maml:para>A scrum workspace query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ScrumWorkspace[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ScrumWorkspace objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentServiceCategoryQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentServiceCategoryQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a service category query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentServiceCategoryQuery cmdlet executes the provided New-XurrentServiceCategoryQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentServiceCategoryQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The service category query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ServiceCategoryQuery</command:parameterValue> <dev:type> <maml:name>ServiceCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The service category query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ServiceCategoryQuery</command:parameterValue> <dev:type> <maml:name>ServiceCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A service category query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceCategory[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ServiceCategory objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentServiceInstanceQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentServiceInstanceQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a service instance query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentServiceInstanceQuery cmdlet executes the provided New-XurrentServiceInstanceQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentServiceInstanceQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The service instance query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The service instance query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceInstance[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ServiceInstance objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentServiceLevelAgreementQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentServiceLevelAgreementQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a service level agreement query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentServiceLevelAgreementQuery cmdlet executes the provided New-XurrentServiceLevelAgreementQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentServiceLevelAgreementQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The service level agreement query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The service level agreement query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceLevelAgreement[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ServiceLevelAgreement objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentServiceOfferingQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentServiceOfferingQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a service offering query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentServiceOfferingQuery cmdlet executes the provided New-XurrentServiceOfferingQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentServiceOfferingQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The service offering query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ServiceOfferingQuery</command:parameterValue> <dev:type> <maml:name>ServiceOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The service offering query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ServiceOfferingQuery</command:parameterValue> <dev:type> <maml:name>ServiceOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>A service offering query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceOffering[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ServiceOffering objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentServiceQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentServiceQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a service query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentServiceQuery cmdlet executes the provided New-XurrentServiceQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentServiceQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The service query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The service query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Service[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Service objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentShopArticleCategoryQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentShopArticleCategoryQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a shop article category query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentShopArticleCategoryQuery cmdlet executes the provided New-XurrentShopArticleCategoryQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentShopArticleCategoryQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The shop article category query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ShopArticleCategoryQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The shop article category query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ShopArticleCategoryQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop article category query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShopArticleCategory[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ShopArticleCategory objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentShopArticleQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentShopArticleQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a shop article query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentShopArticleQuery cmdlet executes the provided New-XurrentShopArticleQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentShopArticleQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The shop article query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ShopArticleQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The shop article query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ShopArticleQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop article query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShopArticle[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ShopArticle objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentShopOrderLineQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentShopOrderLineQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a shop order line query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentShopOrderLineQuery cmdlet executes the provided New-XurrentShopOrderLineQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentShopOrderLineQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The shop order line query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ShopOrderLineQuery</command:parameterValue> <dev:type> <maml:name>ShopOrderLineQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The shop order line query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ShopOrderLineQuery</command:parameterValue> <dev:type> <maml:name>ShopOrderLineQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopOrderLineQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop order line query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShopOrderLine[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ShopOrderLine objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentShortUrlQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentShortUrlQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a short uniform resource locator query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentShortUrlQuery cmdlet executes the provided New-XurrentShortUrlQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentShortUrlQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The short uniform resource locator query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ShortUrlQuery</command:parameterValue> <dev:type> <maml:name>ShortUrlQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The short uniform resource locator query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">ShortUrlQuery</command:parameterValue> <dev:type> <maml:name>ShortUrlQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShortUrlQuery</maml:name> </dev:type> <maml:description> <maml:para>A short uniform resource locator query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShortUrl[]</maml:name> </dev:type> <maml:description> <maml:para>An array of ShortUrl objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentSiteQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentSiteQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a site query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentSiteQuery cmdlet executes the provided New-XurrentSiteQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentSiteQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The site query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The site query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SiteQuery</maml:name> </dev:type> <maml:description> <maml:para>A site query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Site[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Site objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentSkillPoolQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentSkillPoolQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a skill pool query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentSkillPoolQuery cmdlet executes the provided New-XurrentSkillPoolQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentSkillPoolQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The skill pool query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The skill pool query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolQuery</maml:name> </dev:type> <maml:description> <maml:para>A skill pool query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SkillPool[]</maml:name> </dev:type> <maml:description> <maml:para>An array of SkillPool objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentSlaNotificationSchemeQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentSlaNotificationSchemeQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a service level agreement notification scheme query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentSlaNotificationSchemeQuery cmdlet executes the provided New-XurrentSlaNotificationSchemeQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentSlaNotificationSchemeQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The service level agreement notification scheme query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The service level agreement notification scheme query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaNotificationSchemeQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement notification scheme query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SlaNotificationScheme[]</maml:name> </dev:type> <maml:description> <maml:para>An array of SlaNotificationScheme objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentSprintQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentSprintQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a sprint query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentSprintQuery cmdlet executes the provided New-XurrentSprintQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentSprintQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The sprint query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SprintQuery</command:parameterValue> <dev:type> <maml:name>SprintQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The sprint query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SprintQuery</command:parameterValue> <dev:type> <maml:name>SprintQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintQuery</maml:name> </dev:type> <maml:description> <maml:para>A sprint query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Sprint[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Sprint objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentSurveyQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentSurveyQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a survey query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentSurveyQuery cmdlet executes the provided New-XurrentSurveyQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentSurveyQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The survey query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SurveyQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The survey query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SurveyQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Survey[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Survey objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentSurveyResponseQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentSurveyResponseQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a survey response query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentSurveyResponseQuery cmdlet executes the provided New-XurrentSurveyResponseQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentSurveyResponseQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The survey response query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SurveyResponseQuery</command:parameterValue> <dev:type> <maml:name>SurveyResponseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The survey response query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SurveyResponseQuery</command:parameterValue> <dev:type> <maml:name>SurveyResponseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyResponseQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey response query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SurveyResponse[]</maml:name> </dev:type> <maml:description> <maml:para>An array of SurveyResponse objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentSyncSetQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentSyncSetQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a sync set query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentSyncSetQuery cmdlet executes the provided New-XurrentSyncSetQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentSyncSetQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The sync set query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SyncSetQuery</command:parameterValue> <dev:type> <maml:name>SyncSetQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The sync set query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">SyncSetQuery</command:parameterValue> <dev:type> <maml:name>SyncSetQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SyncSetQuery</maml:name> </dev:type> <maml:description> <maml:para>A sync set query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SyncSet[]</maml:name> </dev:type> <maml:description> <maml:para>An array of SyncSet objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentTaskQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentTaskQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a task query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentTaskQuery cmdlet executes the provided New-XurrentTaskQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentTaskQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The task query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The task query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A task query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Task objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentTaskTemplateQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentTaskTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a task template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentTaskTemplateQuery cmdlet executes the provided New-XurrentTaskTemplateQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentTaskTemplateQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The task template query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>TaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The task template query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>TaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A task template query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TaskTemplate[]</maml:name> </dev:type> <maml:description> <maml:para>An array of TaskTemplate objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentTeamQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentTeamQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a team query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentTeamQuery cmdlet executes the provided New-XurrentTeamQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentTeamQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The team query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The team query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Team[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Team objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentTimeAllocationQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentTimeAllocationQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a time allocation query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentTimeAllocationQuery cmdlet executes the provided New-XurrentTimeAllocationQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentTimeAllocationQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The time allocation query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TimeAllocationQuery</command:parameterValue> <dev:type> <maml:name>TimeAllocationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The time allocation query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TimeAllocationQuery</command:parameterValue> <dev:type> <maml:name>TimeAllocationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationQuery</maml:name> </dev:type> <maml:description> <maml:para>A time allocation query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TimeAllocation[]</maml:name> </dev:type> <maml:description> <maml:para>An array of TimeAllocation objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentTimeEntryQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentTimeEntryQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a time entry query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentTimeEntryQuery cmdlet executes the provided New-XurrentTimeEntryQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentTimeEntryQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The time entry query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TimeEntryQuery</command:parameterValue> <dev:type> <maml:name>TimeEntryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The time entry query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TimeEntryQuery</command:parameterValue> <dev:type> <maml:name>TimeEntryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeEntryQuery</maml:name> </dev:type> <maml:description> <maml:para>A time entry query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TimeEntry[]</maml:name> </dev:type> <maml:description> <maml:para>An array of TimeEntry objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentTimesheetSettingQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentTimesheetSettingQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a timesheet setting query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentTimesheetSettingQuery cmdlet executes the provided New-XurrentTimesheetSettingQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentTimesheetSettingQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The timesheet setting query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TimesheetSettingQuery</command:parameterValue> <dev:type> <maml:name>TimesheetSettingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The timesheet setting query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TimesheetSettingQuery</command:parameterValue> <dev:type> <maml:name>TimesheetSettingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimesheetSettingQuery</maml:name> </dev:type> <maml:description> <maml:para>A timesheet setting query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TimesheetSetting[]</maml:name> </dev:type> <maml:description> <maml:para>An array of TimesheetSetting objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentTranslationQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentTranslationQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a translation query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentTranslationQuery cmdlet executes the provided New-XurrentTranslationQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentTranslationQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The translation query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The translation query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Translation[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Translation objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentTrashQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentTrashQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a trash query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentTrashQuery cmdlet executes the provided New-XurrentTrashQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentTrashQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The trash query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TrashQuery</command:parameterValue> <dev:type> <maml:name>TrashQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The trash query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">TrashQuery</command:parameterValue> <dev:type> <maml:name>TrashQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TrashQuery</maml:name> </dev:type> <maml:description> <maml:para>A trash query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Trash[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Trash objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentUiExtensionQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentUiExtensionQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking an user interface extension query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentUiExtensionQuery cmdlet executes the provided New-XurrentUiExtensionQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentUiExtensionQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The user interface extension query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The user interface extension query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>UiExtension[]</maml:name> </dev:type> <maml:description> <maml:para>An array of UiExtension objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentWaitingForCustomerFollowUpQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentWaitingForCustomerFollowUpQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a waiting for customer follow up query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentWaitingForCustomerFollowUpQuery cmdlet executes the provided New-XurrentWaitingForCustomerFollowUpQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentWaitingForCustomerFollowUpQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The waiting for customer follow up query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">WaitingForCustomerFollowUpQuery</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerFollowUpQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The waiting for customer follow up query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">WaitingForCustomerFollowUpQuery</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerFollowUpQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WaitingForCustomerFollowUpQuery</maml:name> </dev:type> <maml:description> <maml:para>A waiting for customer follow up query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WaitingForCustomerFollowUp[]</maml:name> </dev:type> <maml:description> <maml:para>An array of WaitingForCustomerFollowUp objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentWebhookPolicyQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentWebhookPolicyQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a webhook policy query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentWebhookPolicyQuery cmdlet executes the provided New-XurrentWebhookPolicyQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentWebhookPolicyQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The webhook policy query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">WebhookPolicyQuery</command:parameterValue> <dev:type> <maml:name>WebhookPolicyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The webhook policy query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">WebhookPolicyQuery</command:parameterValue> <dev:type> <maml:name>WebhookPolicyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookPolicyQuery</maml:name> </dev:type> <maml:description> <maml:para>A webhook policy query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WebhookPolicy[]</maml:name> </dev:type> <maml:description> <maml:para>An array of WebhookPolicy objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentWebhookQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentWebhookQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a webhook query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentWebhookQuery cmdlet executes the provided New-XurrentWebhookQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentWebhookQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The webhook query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">WebhookQuery</command:parameterValue> <dev:type> <maml:name>WebhookQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The webhook query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">WebhookQuery</command:parameterValue> <dev:type> <maml:name>WebhookQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookQuery</maml:name> </dev:type> <maml:description> <maml:para>A webhook query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Webhook[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Webhook objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentWorkflowQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentWorkflowQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a workflow query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentWorkflowQuery cmdlet executes the provided New-XurrentWorkflowQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentWorkflowQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The workflow query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The workflow query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Workflow[]</maml:name> </dev:type> <maml:description> <maml:para>An array of Workflow objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentWorkflowTemplateQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentWorkflowTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a workflow template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentWorkflowTemplateQuery cmdlet executes the provided New-XurrentWorkflowTemplateQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentWorkflowTemplateQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The workflow template query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The workflow template query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow template query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WorkflowTemplate[]</maml:name> </dev:type> <maml:description> <maml:para>An array of WorkflowTemplate objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-XurrentWorkflowTypeQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>XurrentWorkflowTypeQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for invoking a workflow type query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Invoke-XurrentWorkflowTypeQuery cmdlet executes the provided New-XurrentWorkflowTypeQuery cmdlet and returns the results.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-XurrentWorkflowTypeQuery</maml:name> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The workflow type query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowTypeQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTypeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Query</maml:name> <maml:description> <maml:para>The workflow type query to be executed.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowTypeQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTypeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client is used to execute the query. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTypeQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow type query object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WorkflowType[]</maml:name> </dev:type> <maml:description> <maml:para>An array of WorkflowType objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAccountQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAccountQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an account query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAccountQuery cmdlet creates and configures an account query object using the provided parameters. These result can be used with the Invoke-XurrentAccountQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAccountQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an account properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AccountField[]</command:parameterValue> <dev:type> <maml:name>AccountField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>DirectoryAccount</maml:name> <maml:description> <maml:para>Specify the directory account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Specify the organization details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an account properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AccountField[]</command:parameterValue> <dev:type> <maml:name>AccountField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>DirectoryAccount</maml:name> <maml:description> <maml:para>Specify the directory account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Specify the organization details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountField[]</maml:name> </dev:type> <maml:description> <maml:para>The Account field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentActivityIDQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentActivityIDQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an activity identifier query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentActivityIDQuery cmdlet creates and configures an activity identifier query object using the provided parameters. These result can be used with the Invoke-XurrentActivityIDQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentActivityIDQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an activity identifier properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ActivityIDField[]</command:parameterValue> <dev:type> <maml:name>ActivityIDField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an activity identifier properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ActivityIDField[]</command:parameterValue> <dev:type> <maml:name>ActivityIDField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ActivityIDField[]</maml:name> </dev:type> <maml:description> <maml:para>The Activity ID field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ActivityIDQuery</maml:name> </dev:type> <maml:description> <maml:para>An activity identifier query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAddressQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAddressQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an address query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAddressQuery cmdlet creates and configures an address query object using the provided parameters. These result can be used with the Invoke-XurrentAddressQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAddressQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an address properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AddressField[]</command:parameterValue> <dev:type> <maml:name>AddressField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an address properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AddressField[]</command:parameterValue> <dev:type> <maml:name>AddressField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressField[]</maml:name> </dev:type> <maml:description> <maml:para>The Address field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AddressQuery</maml:name> </dev:type> <maml:description> <maml:para>An address query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAffectedSlaQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAffectedSlaQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an affected service level agreement query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAffectedSlaQuery cmdlet creates and configures an affected service level agreement query object using the provided parameters. These result can be used with the Invoke-XurrentAffectedSlaQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAffectedSlaQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the affected SLA query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an affected service level agreement properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AffectedSlaField[]</command:parameterValue> <dev:type> <maml:name>AffectedSlaField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AffectedSlaView</command:parameterValue> <dev:type> <maml:name>AffectedSlaView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AffectedSlaOrderField</command:parameterValue> <dev:type> <maml:name>AffectedSlaOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>FirstLineTeam</maml:name> <maml:description> <maml:para>Specify the first line team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Request</maml:name> <maml:description> <maml:para>Specify the request details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ServiceHours</maml:name> <maml:description> <maml:para>Specify the service hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServiceLevelAgreement</maml:name> <maml:description> <maml:para>Specify the service level agreement details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>StandardServiceRequest</maml:name> <maml:description> <maml:para>Specify the standard service request details to be returned using a standard service request query.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestQuery</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>StoppedClockPeriods</maml:name> <maml:description> <maml:para>Specify the stopped clock periods details to be returned using a period query.</maml:para> </maml:description> <command:parameterValue required="false">PeriodQuery</command:parameterValue> <dev:type> <maml:name>PeriodQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SupportHours</maml:name> <maml:description> <maml:para>Specify the support hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SupportTeam</maml:name> <maml:description> <maml:para>Specify the support team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<AffectedSlaQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<AffectedSlaQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<AffectedSlaQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the affected SLA query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an affected service level agreement properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AffectedSlaField[]</command:parameterValue> <dev:type> <maml:name>AffectedSlaField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AffectedSlaView</command:parameterValue> <dev:type> <maml:name>AffectedSlaView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AffectedSlaOrderField</command:parameterValue> <dev:type> <maml:name>AffectedSlaOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>FirstLineTeam</maml:name> <maml:description> <maml:para>Specify the first line team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Request</maml:name> <maml:description> <maml:para>Specify the request details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ServiceHours</maml:name> <maml:description> <maml:para>Specify the service hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServiceLevelAgreement</maml:name> <maml:description> <maml:para>Specify the service level agreement details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>StandardServiceRequest</maml:name> <maml:description> <maml:para>Specify the standard service request details to be returned using a standard service request query.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestQuery</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>StoppedClockPeriods</maml:name> <maml:description> <maml:para>Specify the stopped clock periods details to be returned using a period query.</maml:para> </maml:description> <command:parameterValue required="false">PeriodQuery</command:parameterValue> <dev:type> <maml:name>PeriodQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SupportHours</maml:name> <maml:description> <maml:para>Specify the support hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SupportTeam</maml:name> <maml:description> <maml:para>Specify the support team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<AffectedSlaQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<AffectedSlaQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<AffectedSlaQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AffectedSlaField[]</maml:name> </dev:type> <maml:description> <maml:para>The Affected SLA field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AffectedSlaView</maml:name> </dev:type> <maml:description> <maml:para>The affected service level agreement view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AffectedSlaOrderField</maml:name> </dev:type> <maml:description> <maml:para>The affected service level agreement order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.StandardServiceRequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A standard service request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PeriodQuery</maml:name> </dev:type> <maml:description> <maml:para>A period query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<AffectedSlaQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>An affected service level agreement query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AffectedSlaQuery</maml:name> </dev:type> <maml:description> <maml:para>An affected service level agreement query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAffectedSlaQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentAffectedSlaQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new affected service level agreement query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAffectedSlaQueryFilter cmdlet creates and configures an affected service level agreement query filter object using the provided parameters. These filters can be used with the New-XurrentAffectedSlaQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAffectedSlaQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">AffectedSlaFilter</command:parameterValue> <dev:type> <maml:name>AffectedSlaFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">AffectedSlaFilter</command:parameterValue> <dev:type> <maml:name>AffectedSlaFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AffectedSlaFilter</maml:name> </dev:type> <maml:description> <maml:para>an affected service level agreement filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<AffectedSlaQuery></maml:name> </dev:type> <maml:description> <maml:para>An affected service level agreement query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAgileBoard</command:name> <command:verb>New</command:verb> <command:noun>XurrentAgileBoard</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new agile board.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates an agile board using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAgileBoard</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the agile board.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomerRepresentativeSlaIds</maml:name> <maml:description> <maml:para>Identifiers of the service level agreements of which the customer representatives can view this board in Self Service.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the agile board.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the board may not be used to place items on.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the manager of the agile board.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>NewColumns</maml:name> <maml:description> <maml:para>Columns of this agile board.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnInput[]</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of agile board properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AgileBoardField[]</command:parameterValue> <dev:type> <maml:name>AgileBoardField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the agile board.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomerRepresentativeSlaIds</maml:name> <maml:description> <maml:para>Identifiers of the service level agreements of which the customer representatives can view this board in Self Service.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the agile board.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the board may not be used to place items on.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the manager of the agile board.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>NewColumns</maml:name> <maml:description> <maml:para>Columns of this agile board.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnInput[]</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of agile board properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AgileBoardField[]</command:parameterValue> <dev:type> <maml:name>AgileBoardField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardColumnInput[]</maml:name> </dev:type> <maml:description> <maml:para>An agile board column input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardField[]</maml:name> </dev:type> <maml:description> <maml:para>The agile board field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AgileBoard</maml:name> </dev:type> <maml:description> <maml:para>An agile board object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAgileBoardColumnQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAgileBoardColumnQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an agile board column query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAgileBoardColumnQuery cmdlet creates and configures an agile board column query object using the provided parameters. These result can be used with the Invoke-XurrentAgileBoardColumnQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAgileBoardColumnQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an agile board column properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AgileBoardColumnField[]</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Items</maml:name> <maml:description> <maml:para>Specify the items details to be returned using an agile board item query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardItemQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specify the member details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an agile board column properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AgileBoardColumnField[]</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Items</maml:name> <maml:description> <maml:para>Specify the items details to be returned using an agile board item query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardItemQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specify the member details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardColumnField[]</maml:name> </dev:type> <maml:description> <maml:para>The Agile board column field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardItemQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board column query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAgileBoardItemQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAgileBoardItemQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an agile board item query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAgileBoardItemQuery cmdlet creates and configures an agile board item query object using the provided parameters. These result can be used with the Invoke-XurrentAgileBoardItemQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAgileBoardItemQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an agile board item properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AgileBoardItemField[]</command:parameterValue> <dev:type> <maml:name>AgileBoardItemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardColumn</maml:name> <maml:description> <maml:para>Specify the agile board column details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an agile board item properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AgileBoardItemField[]</command:parameterValue> <dev:type> <maml:name>AgileBoardItemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardColumn</maml:name> <maml:description> <maml:para>Specify the agile board column details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardItemField[]</maml:name> </dev:type> <maml:description> <maml:para>The Agile board item field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardColumnQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board column query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AgileBoardItemQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board item query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAgileBoardQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAgileBoardQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an agile board query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAgileBoardQuery cmdlet creates and configures an agile board query object using the provided parameters. These result can be used with the Invoke-XurrentAgileBoardQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAgileBoardQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the agile board query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an agile board properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AgileBoardField[]</command:parameterValue> <dev:type> <maml:name>AgileBoardField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardView</command:parameterValue> <dev:type> <maml:name>AgileBoardView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardOrderField</command:parameterValue> <dev:type> <maml:name>AgileBoardOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Columns</maml:name> <maml:description> <maml:para>Specify the columns details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CurrentSprint</maml:name> <maml:description> <maml:para>Specify the current sprint details to be returned using a sprint query.</maml:para> </maml:description> <command:parameterValue required="false">SprintQuery</command:parameterValue> <dev:type> <maml:name>SprintQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomerRepresentativeSlas</maml:name> <maml:description> <maml:para>Specify the customer representative SLAs details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<AgileBoardQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<AgileBoardQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<AgileBoardQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the agile board query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an agile board properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AgileBoardField[]</command:parameterValue> <dev:type> <maml:name>AgileBoardField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardView</command:parameterValue> <dev:type> <maml:name>AgileBoardView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardOrderField</command:parameterValue> <dev:type> <maml:name>AgileBoardOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Columns</maml:name> <maml:description> <maml:para>Specify the columns details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CurrentSprint</maml:name> <maml:description> <maml:para>Specify the current sprint details to be returned using a sprint query.</maml:para> </maml:description> <command:parameterValue required="false">SprintQuery</command:parameterValue> <dev:type> <maml:name>SprintQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomerRepresentativeSlas</maml:name> <maml:description> <maml:para>Specify the customer representative SLAs details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<AgileBoardQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<AgileBoardQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<AgileBoardQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardField[]</maml:name> </dev:type> <maml:description> <maml:para>The Agile board field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardView</maml:name> </dev:type> <maml:description> <maml:para>The agile board view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardOrderField</maml:name> </dev:type> <maml:description> <maml:para>The agile board order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardColumnQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board column query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintQuery</maml:name> </dev:type> <maml:description> <maml:para>A sprint query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<AgileBoardQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>An agile board query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAgileBoardQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentAgileBoardQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new agile board query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAgileBoardQueryFilter cmdlet creates and configures an agile board query filter object using the provided parameters. These filters can be used with the New-XurrentAgileBoardQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAgileBoardQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">AgileBoardFilter</command:parameterValue> <dev:type> <maml:name>AgileBoardFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">AgileBoardFilter</command:parameterValue> <dev:type> <maml:name>AgileBoardFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardFilter</maml:name> </dev:type> <maml:description> <maml:para>an agile board filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<AgileBoardQuery></maml:name> </dev:type> <maml:description> <maml:para>An agile board query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAppInstance</command:name> <command:verb>New</command:verb> <command:noun>XurrentAppInstance</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new app instance.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates an app instance using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAppInstance</maml:name> <command:parameter required="true" position="0"> <maml:name>AppOfferingId</maml:name> <maml:description> <maml:para>Identifier of the app offering to create an instance of.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>CustomerAccountId</maml:name> <maml:description> <maml:para>Identifier of the account this app instance is for.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerRepresentativeId</maml:name> <maml:description> <maml:para>Identifier of the contact person of customer regarding this app instance.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the app instance is currently enabled for this customer.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EnabledByCustomer</maml:name> <maml:description> <maml:para>Whether the customer has enabled this app instance.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Suspended</maml:name> <maml:description> <maml:para>Whether the app instance is currently suspended for this customer.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SuspensionComment</maml:name> <maml:description> <maml:para>Extra information why the app instance is currently suspended for this customer.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of app instance properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppInstanceField[]</command:parameterValue> <dev:type> <maml:name>AppInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>AppOfferingId</maml:name> <maml:description> <maml:para>Identifier of the app offering to create an instance of.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>CustomerAccountId</maml:name> <maml:description> <maml:para>Identifier of the account this app instance is for.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerRepresentativeId</maml:name> <maml:description> <maml:para>Identifier of the contact person of customer regarding this app instance.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the app instance is currently enabled for this customer.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EnabledByCustomer</maml:name> <maml:description> <maml:para>Whether the customer has enabled this app instance.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Suspended</maml:name> <maml:description> <maml:para>Whether the app instance is currently suspended for this customer.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SuspensionComment</maml:name> <maml:description> <maml:para>Extra information why the app instance is currently suspended for this customer.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of app instance properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppInstanceField[]</command:parameterValue> <dev:type> <maml:name>AppInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppInstanceField[]</maml:name> </dev:type> <maml:description> <maml:para>The app instance field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AppInstance</maml:name> </dev:type> <maml:description> <maml:para>An app instance object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAppInstanceQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAppInstanceQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an app instance query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAppInstanceQuery cmdlet creates and configures an app instance query object using the provided parameters. These result can be used with the Invoke-XurrentAppInstanceQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAppInstanceQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the app instance query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an app instance properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppInstanceField[]</command:parameterValue> <dev:type> <maml:name>AppInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AppInstanceView</command:parameterValue> <dev:type> <maml:name>AppInstanceView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AppInstanceOrderField</command:parameterValue> <dev:type> <maml:name>AppInstanceOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AppOffering</maml:name> <maml:description> <maml:para>Specify the app offering details to be returned using an app offering query.</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingQuery</command:parameterValue> <dev:type> <maml:name>AppOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomerAccount</maml:name> <maml:description> <maml:para>Specify the customer account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomerRepresentative</maml:name> <maml:description> <maml:para>Specify the customer representative details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Webhook</maml:name> <maml:description> <maml:para>Specify the webhook details to be returned using a webhook query.</maml:para> </maml:description> <command:parameterValue required="false">WebhookQuery</command:parameterValue> <dev:type> <maml:name>WebhookQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>WebhookPolicy</maml:name> <maml:description> <maml:para>Specify the webhook policy details to be returned using a webhook policy query.</maml:para> </maml:description> <command:parameterValue required="false">WebhookPolicyQuery</command:parameterValue> <dev:type> <maml:name>WebhookPolicyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<AppInstanceQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<AppInstanceQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<AppInstanceQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the app instance query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an app instance properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppInstanceField[]</command:parameterValue> <dev:type> <maml:name>AppInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AppInstanceView</command:parameterValue> <dev:type> <maml:name>AppInstanceView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AppInstanceOrderField</command:parameterValue> <dev:type> <maml:name>AppInstanceOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AppOffering</maml:name> <maml:description> <maml:para>Specify the app offering details to be returned using an app offering query.</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingQuery</command:parameterValue> <dev:type> <maml:name>AppOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomerAccount</maml:name> <maml:description> <maml:para>Specify the customer account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomerRepresentative</maml:name> <maml:description> <maml:para>Specify the customer representative details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Webhook</maml:name> <maml:description> <maml:para>Specify the webhook details to be returned using a webhook query.</maml:para> </maml:description> <command:parameterValue required="false">WebhookQuery</command:parameterValue> <dev:type> <maml:name>WebhookQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>WebhookPolicy</maml:name> <maml:description> <maml:para>Specify the webhook policy details to be returned using a webhook policy query.</maml:para> </maml:description> <command:parameterValue required="false">WebhookPolicyQuery</command:parameterValue> <dev:type> <maml:name>WebhookPolicyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<AppInstanceQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<AppInstanceQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<AppInstanceQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppInstanceField[]</maml:name> </dev:type> <maml:description> <maml:para>The App instance field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppInstanceView</maml:name> </dev:type> <maml:description> <maml:para>The app instance view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppInstanceOrderField</maml:name> </dev:type> <maml:description> <maml:para>The app instance order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>An app offering query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookQuery</maml:name> </dev:type> <maml:description> <maml:para>A webhook query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookPolicyQuery</maml:name> </dev:type> <maml:description> <maml:para>A webhook policy query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<AppInstanceQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>An app instance query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AppInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>An app instance query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAppInstanceQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentAppInstanceQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new app instance query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAppInstanceQueryFilter cmdlet creates and configures an app instance query filter object using the provided parameters. These filters can be used with the New-XurrentAppInstanceQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAppInstanceQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">AppInstanceFilter</command:parameterValue> <dev:type> <maml:name>AppInstanceFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">AppInstanceFilter</command:parameterValue> <dev:type> <maml:name>AppInstanceFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppInstanceFilter</maml:name> </dev:type> <maml:description> <maml:para>an app instance filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<AppInstanceQuery></maml:name> </dev:type> <maml:description> <maml:para>An app instance query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAppOffering</command:name> <command:verb>New</command:verb> <command:noun>XurrentAppOffering</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new app offering.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates an app offering using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAppOffering</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the app offering.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the the service instance this app offering is linked to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CardDescription</maml:name> <maml:description> <maml:para>Short description of the app offering to be shown on the card in the App store.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Compliance</maml:name> <maml:description> <maml:para>Compliance description of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ConfigurationUriTemplate</maml:name> <maml:description> <maml:para>The URI where the app can be configured. The placeholder {account} can be used to include the customer account id in the URI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the app offering may not be used for new instances.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Features</maml:name> <maml:description> <maml:para>Feature description of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>NewScopes</maml:name> <maml:description> <maml:para>Scopes of this app offering</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingScopeInput[]</command:parameterValue> <dev:type> <maml:name>AppOfferingScopeInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>OauthAuthorizationEndpoints</maml:name> <maml:description> <maml:para>The endpoints for the OAuth application that will be created for this app to use in the Authorization Code Grant flow.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PolicyJwtAlg</maml:name> <maml:description> <maml:para>The algorithm used for generating the policy for the app offering's webhook.</maml:para> </maml:description> <command:parameterValue required="false">WebhookPolicyJwtAlg</command:parameterValue> <dev:type> <maml:name>WebhookPolicyJwtAlg</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PolicyJwtAudience</maml:name> <maml:description> <maml:para>The audience for the policy for the app offering's webhook.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PolicyJwtClaimExpiresIn</maml:name> <maml:description> <maml:para>The claim expiry time for the policy for the app offering's webhook.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Reference</maml:name> <maml:description> <maml:para>This reference can be used to link the app offering to an instance using the Xurrent APIs or the Xurrent Import functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>RequiresEnabledOauthPerson</maml:name> <maml:description> <maml:para>This app requires an enabled OAuth person.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>UiExtensionVersionId</maml:name> <maml:description> <maml:para>Identifier of the UI extension version that is linked to the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>WebhookUriTemplate</maml:name> <maml:description> <maml:para>The URI for the app offering's webhook. The placeholder {account} can be used to include the customer account id in the URI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="23"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of app offering properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the app offering.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the the service instance this app offering is linked to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CardDescription</maml:name> <maml:description> <maml:para>Short description of the app offering to be shown on the card in the App store.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Compliance</maml:name> <maml:description> <maml:para>Compliance description of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ConfigurationUriTemplate</maml:name> <maml:description> <maml:para>The URI where the app can be configured. The placeholder {account} can be used to include the customer account id in the URI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the app offering may not be used for new instances.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Features</maml:name> <maml:description> <maml:para>Feature description of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>NewScopes</maml:name> <maml:description> <maml:para>Scopes of this app offering</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingScopeInput[]</command:parameterValue> <dev:type> <maml:name>AppOfferingScopeInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>OauthAuthorizationEndpoints</maml:name> <maml:description> <maml:para>The endpoints for the OAuth application that will be created for this app to use in the Authorization Code Grant flow.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PolicyJwtAlg</maml:name> <maml:description> <maml:para>The algorithm used for generating the policy for the app offering's webhook.</maml:para> </maml:description> <command:parameterValue required="false">WebhookPolicyJwtAlg</command:parameterValue> <dev:type> <maml:name>WebhookPolicyJwtAlg</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PolicyJwtAudience</maml:name> <maml:description> <maml:para>The audience for the policy for the app offering's webhook.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PolicyJwtClaimExpiresIn</maml:name> <maml:description> <maml:para>The claim expiry time for the policy for the app offering's webhook.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Reference</maml:name> <maml:description> <maml:para>This reference can be used to link the app offering to an instance using the Xurrent APIs or the Xurrent Import functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>RequiresEnabledOauthPerson</maml:name> <maml:description> <maml:para>This app requires an enabled OAuth person.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>UiExtensionVersionId</maml:name> <maml:description> <maml:para>Identifier of the UI extension version that is linked to the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>WebhookUriTemplate</maml:name> <maml:description> <maml:para>The URI for the app offering's webhook. The placeholder {account} can be used to include the customer account id in the URI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="23"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of app offering properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingScopeInput[]</maml:name> </dev:type> <maml:description> <maml:para>An app offering scope input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookPolicyJwtAlg</maml:name> </dev:type> <maml:description> <maml:para>A webhook policy JSON web token alg object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingField[]</maml:name> </dev:type> <maml:description> <maml:para>The app offering field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AppOffering</maml:name> </dev:type> <maml:description> <maml:para>An app offering object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAppOfferingAutomationRule</command:name> <command:verb>New</command:verb> <command:noun>XurrentAppOfferingAutomationRule</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new app offering automation rule.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates an app offering automation rule using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAppOfferingAutomationRule</maml:name> <command:parameter required="true" position="0"> <maml:name>AppOfferingId</maml:name> <maml:description> <maml:para>Identifier of the app offering the rule belongs to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Condition</maml:name> <maml:description> <maml:para>The Condition field is used to define the condition that needs to be met in order for the update action(s) of the rule to be performed. For example: is_assigned and !badge.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the automation rule.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>The Trigger field is used to specify when the automation rule is to be triggered, for example on status update or on note added.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Actions</maml:name> <maml:description> <maml:para>The Actions field is used to define actions that should be executed when the condition of the automation rule is met.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleActionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the automation rule's function.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Expressions</maml:name> <maml:description> <maml:para>The Expressions field is used to define expressions that can subsequently be used to define the rule's conditions and the update action(s) that the rule is to perform.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleExpressionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Generic</maml:name> <maml:description> <maml:para>The record type this rule is linked to.Valid values are:• request• task• ci</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Position</maml:name> <maml:description> <maml:para>The Position field dictates the order in which the automation rule is executed.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of app offering automation rule properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingAutomationRuleField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingAutomationRuleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>AppOfferingId</maml:name> <maml:description> <maml:para>Identifier of the app offering the rule belongs to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Condition</maml:name> <maml:description> <maml:para>The Condition field is used to define the condition that needs to be met in order for the update action(s) of the rule to be performed. For example: is_assigned and !badge.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the automation rule.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>The Trigger field is used to specify when the automation rule is to be triggered, for example on status update or on note added.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Actions</maml:name> <maml:description> <maml:para>The Actions field is used to define actions that should be executed when the condition of the automation rule is met.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleActionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the automation rule's function.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Expressions</maml:name> <maml:description> <maml:para>The Expressions field is used to define expressions that can subsequently be used to define the rule's conditions and the update action(s) that the rule is to perform.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleExpressionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Generic</maml:name> <maml:description> <maml:para>The record type this rule is linked to.Valid values are:• request• task• ci</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Position</maml:name> <maml:description> <maml:para>The Position field dictates the order in which the automation rule is executed.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of app offering automation rule properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingAutomationRuleField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingAutomationRuleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleActionInput[]</maml:name> </dev:type> <maml:description> <maml:para>An automation rule action input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleExpressionInput[]</maml:name> </dev:type> <maml:description> <maml:para>An automation rule expression input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingAutomationRuleField[]</maml:name> </dev:type> <maml:description> <maml:para>The app offering automation rule field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AppOfferingAutomationRule</maml:name> </dev:type> <maml:description> <maml:para>An app offering automation rule object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAppOfferingAutomationRuleQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAppOfferingAutomationRuleQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an app offering automation rule query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAppOfferingAutomationRuleQuery cmdlet creates and configures an app offering automation rule query object using the provided parameters. These result can be used with the Invoke-XurrentAppOfferingAutomationRuleQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAppOfferingAutomationRuleQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an app offering automation rule properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingAutomationRuleField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingAutomationRuleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Actions</maml:name> <maml:description> <maml:para>Specify the actions details to be returned using an automation rule action query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleActionQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AppOffering</maml:name> <maml:description> <maml:para>Specify the app offering details to be returned using an app offering query.</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingQuery</command:parameterValue> <dev:type> <maml:name>AppOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Expressions</maml:name> <maml:description> <maml:para>Specify the expressions details to be returned using an automation rule expression query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleExpressionQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an app offering automation rule properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingAutomationRuleField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingAutomationRuleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Actions</maml:name> <maml:description> <maml:para>Specify the actions details to be returned using an automation rule action query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleActionQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AppOffering</maml:name> <maml:description> <maml:para>Specify the app offering details to be returned using an app offering query.</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingQuery</command:parameterValue> <dev:type> <maml:name>AppOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Expressions</maml:name> <maml:description> <maml:para>Specify the expressions details to be returned using an automation rule expression query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleExpressionQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingAutomationRuleField[]</maml:name> </dev:type> <maml:description> <maml:para>The App offering automation rule field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleActionQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule action query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>An app offering query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleExpressionQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule expression query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AppOfferingAutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An app offering automation rule query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAppOfferingQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAppOfferingQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an app offering query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAppOfferingQuery cmdlet creates and configures an app offering query object using the provided parameters. These result can be used with the Invoke-XurrentAppOfferingQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAppOfferingQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the app offering query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an app offering properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingView</command:parameterValue> <dev:type> <maml:name>AppOfferingView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingOrderField</command:parameterValue> <dev:type> <maml:name>AppOfferingOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AppInstances</maml:name> <maml:description> <maml:para>Specify the app instances details to be returned using an app instance query.</maml:para> </maml:description> <command:parameterValue required="false">AppInstanceQuery</command:parameterValue> <dev:type> <maml:name>AppInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an app offering automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingAutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AppOfferingAutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ComplianceAttachments</maml:name> <maml:description> <maml:para>Specify the compliance attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FeaturesAttachments</maml:name> <maml:description> <maml:para>Specify the features attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>Specify the scopes details to be returned using an app offering scope query.</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingScopeQuery</command:parameterValue> <dev:type> <maml:name>AppOfferingScopeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>UiExtensionVersion</maml:name> <maml:description> <maml:para>Specify the UI extension version details to be returned using an user interface extension version query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionVersionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionVersionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<AppOfferingQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<AppOfferingQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<AppOfferingQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the app offering query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an app offering properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingView</command:parameterValue> <dev:type> <maml:name>AppOfferingView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingOrderField</command:parameterValue> <dev:type> <maml:name>AppOfferingOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AppInstances</maml:name> <maml:description> <maml:para>Specify the app instances details to be returned using an app instance query.</maml:para> </maml:description> <command:parameterValue required="false">AppInstanceQuery</command:parameterValue> <dev:type> <maml:name>AppInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an app offering automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingAutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AppOfferingAutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ComplianceAttachments</maml:name> <maml:description> <maml:para>Specify the compliance attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FeaturesAttachments</maml:name> <maml:description> <maml:para>Specify the features attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>Specify the scopes details to be returned using an app offering scope query.</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingScopeQuery</command:parameterValue> <dev:type> <maml:name>AppOfferingScopeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>UiExtensionVersion</maml:name> <maml:description> <maml:para>Specify the UI extension version details to be returned using an user interface extension version query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionVersionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionVersionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<AppOfferingQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<AppOfferingQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<AppOfferingQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingField[]</maml:name> </dev:type> <maml:description> <maml:para>The App offering field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingView</maml:name> </dev:type> <maml:description> <maml:para>The app offering view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingOrderField</maml:name> </dev:type> <maml:description> <maml:para>The app offering order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>An app instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingAutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An app offering automation rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingScopeQuery</maml:name> </dev:type> <maml:description> <maml:para>An app offering scope query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionVersionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension version query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<AppOfferingQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>An app offering query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AppOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>An app offering query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAppOfferingQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentAppOfferingQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new app offering query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAppOfferingQueryFilter cmdlet creates and configures an app offering query filter object using the provided parameters. These filters can be used with the New-XurrentAppOfferingQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAppOfferingQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">AppOfferingFilter</command:parameterValue> <dev:type> <maml:name>AppOfferingFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">AppOfferingFilter</command:parameterValue> <dev:type> <maml:name>AppOfferingFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingFilter</maml:name> </dev:type> <maml:description> <maml:para>an app offering filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<AppOfferingQuery></maml:name> </dev:type> <maml:description> <maml:para>An app offering query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAppOfferingScopeQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAppOfferingScopeQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an app offering scope query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAppOfferingScopeQuery cmdlet creates and configures an app offering scope query object using the provided parameters. These result can be used with the Invoke-XurrentAppOfferingScopeQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAppOfferingScopeQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an app offering scope properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingScopeField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingScopeField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an app offering scope properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingScopeField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingScopeField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingScopeField[]</maml:name> </dev:type> <maml:description> <maml:para>The App offering scope field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AppOfferingScopeQuery</maml:name> </dev:type> <maml:description> <maml:para>An app offering scope query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentArchiveQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentArchiveQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an archive query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentArchiveQuery cmdlet creates and configures an archive query object using the provided parameters. These result can be used with the Invoke-XurrentArchiveQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentArchiveQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the archive query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an archive properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ArchiveField[]</command:parameterValue> <dev:type> <maml:name>ArchiveField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ArchiveView</command:parameterValue> <dev:type> <maml:name>ArchiveView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ArchiveOrderField</command:parameterValue> <dev:type> <maml:name>ArchiveOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ArchivedPerson</maml:name> <maml:description> <maml:para>Specify the archived Person to be returned using a person query. This only applies if the item is a person.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ArchivedProblem</maml:name> <maml:description> <maml:para>Specify the archived Problem to be returned using a problem query. This only applies if the item is a problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ArchivedProject</maml:name> <maml:description> <maml:para>Specify the archived Project to be returned using a project query. This only applies if the item is a project.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ArchivedProjectTask</maml:name> <maml:description> <maml:para>Specify the archived Project task to be returned using a project task query. This only applies if the item is a project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ArchivedRelease</maml:name> <maml:description> <maml:para>Specify the archived Release to be returned using a release query. This only applies if the item is a release.</maml:para> </maml:description> <command:parameterValue required="false">ReleaseQuery</command:parameterValue> <dev:type> <maml:name>ReleaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ArchivedRequest</maml:name> <maml:description> <maml:para>Specify the archived Request to be returned using a request query. This only applies if the item is a request.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ArchivedRisk</maml:name> <maml:description> <maml:para>Specify the archived Risk to be returned using a risk query. This only applies if the item is a risk.</maml:para> </maml:description> <command:parameterValue required="false">RiskQuery</command:parameterValue> <dev:type> <maml:name>RiskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ArchivedTask</maml:name> <maml:description> <maml:para>Specify the archived Task to be returned using a task query. This only applies if the item is a task.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ArchivedWorkflow</maml:name> <maml:description> <maml:para>Specify the archived Workflow to be returned using a workflow query. This only applies if the item is a workflow.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ArchivedBy</maml:name> <maml:description> <maml:para>Specify the archived by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ArchiveQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ArchiveQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ArchiveQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the archive query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an archive properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ArchiveField[]</command:parameterValue> <dev:type> <maml:name>ArchiveField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ArchiveView</command:parameterValue> <dev:type> <maml:name>ArchiveView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ArchiveOrderField</command:parameterValue> <dev:type> <maml:name>ArchiveOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ArchivedPerson</maml:name> <maml:description> <maml:para>Specify the archived Person to be returned using a person query. This only applies if the item is a person.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ArchivedProblem</maml:name> <maml:description> <maml:para>Specify the archived Problem to be returned using a problem query. This only applies if the item is a problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ArchivedProject</maml:name> <maml:description> <maml:para>Specify the archived Project to be returned using a project query. This only applies if the item is a project.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ArchivedProjectTask</maml:name> <maml:description> <maml:para>Specify the archived Project task to be returned using a project task query. This only applies if the item is a project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ArchivedRelease</maml:name> <maml:description> <maml:para>Specify the archived Release to be returned using a release query. This only applies if the item is a release.</maml:para> </maml:description> <command:parameterValue required="false">ReleaseQuery</command:parameterValue> <dev:type> <maml:name>ReleaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ArchivedRequest</maml:name> <maml:description> <maml:para>Specify the archived Request to be returned using a request query. This only applies if the item is a request.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ArchivedRisk</maml:name> <maml:description> <maml:para>Specify the archived Risk to be returned using a risk query. This only applies if the item is a risk.</maml:para> </maml:description> <command:parameterValue required="false">RiskQuery</command:parameterValue> <dev:type> <maml:name>RiskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ArchivedTask</maml:name> <maml:description> <maml:para>Specify the archived Task to be returned using a task query. This only applies if the item is a task.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ArchivedWorkflow</maml:name> <maml:description> <maml:para>Specify the archived Workflow to be returned using a workflow query. This only applies if the item is a workflow.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ArchivedBy</maml:name> <maml:description> <maml:para>Specify the archived by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ArchiveQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ArchiveQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ArchiveQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ArchiveField[]</maml:name> </dev:type> <maml:description> <maml:para>The Archive field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ArchiveView</maml:name> </dev:type> <maml:description> <maml:para>The archive view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ArchiveOrderField</maml:name> </dev:type> <maml:description> <maml:para>The archive order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemQuery</maml:name> </dev:type> <maml:description> <maml:para>A problem query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectQuery</maml:name> </dev:type> <maml:description> <maml:para>A project query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReleaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A release query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskQuery</maml:name> </dev:type> <maml:description> <maml:para>A risk query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ArchiveQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>An archive query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ArchiveQuery</maml:name> </dev:type> <maml:description> <maml:para>An archive query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentArchiveQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentArchiveQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new archive query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentArchiveQueryFilter cmdlet creates and configures an archive query filter object using the provided parameters. These filters can be used with the New-XurrentArchiveQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentArchiveQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ArchiveFilter</command:parameterValue> <dev:type> <maml:name>ArchiveFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ArchiveFilter</command:parameterValue> <dev:type> <maml:name>ArchiveFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ArchiveFilter</maml:name> </dev:type> <maml:description> <maml:para>an archive filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ArchiveQuery></maml:name> </dev:type> <maml:description> <maml:para>An archive query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAsyncQueryQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAsyncQueryQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an async query query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAsyncQueryQuery cmdlet creates and configures an async query query object using the provided parameters. These result can be used with the Invoke-XurrentAsyncQueryQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAsyncQueryQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an async query properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AsyncQueryField[]</command:parameterValue> <dev:type> <maml:name>AsyncQueryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an async query properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AsyncQueryField[]</command:parameterValue> <dev:type> <maml:name>AsyncQueryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AsyncQueryField[]</maml:name> </dev:type> <maml:description> <maml:para>The Async query field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AsyncQueryQuery</maml:name> </dev:type> <maml:description> <maml:para>An async query query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAttachment</command:name> <command:verb>New</command:verb> <command:noun>XurrentAttachment</command:noun> <command:description> <maml:para>A PowerShell cmdlet to create an attachment upload object.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAttachment cmdlet creates an attachment upload object.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAttachment</maml:name> <command:parameter required="true" position="0"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key obtained from the attachment upload response.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Inline</maml:name> <maml:description> <maml:para>Whether the attachment is an inline image.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Size</maml:name> <maml:description> <maml:para>The size of the attachment in bytes.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key obtained from the attachment upload response.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Inline</maml:name> <maml:description> <maml:para>Whether the attachment is an inline image.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Size</maml:name> <maml:description> <maml:para>The size of the attachment in bytes.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput</maml:name> </dev:type> <maml:description> <maml:para>The attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AttachmentInput</maml:name> </dev:type> <maml:description> <maml:para>The attachment input object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAttachmentQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAttachmentQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an attachment query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAttachmentQuery cmdlet creates and configures an attachment query object using the provided parameters. These result can be used with the Invoke-XurrentAttachmentQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAttachmentQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an attachment properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AttachmentField[]</command:parameterValue> <dev:type> <maml:name>AttachmentField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an attachment properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AttachmentField[]</command:parameterValue> <dev:type> <maml:name>AttachmentField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentField[]</maml:name> </dev:type> <maml:description> <maml:para>The Attachment field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAttachmentStorageQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAttachmentStorageQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an attachment storage query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAttachmentStorageQuery cmdlet creates and configures an attachment storage query object using the provided parameters. These result can be used with the Invoke-XurrentAttachmentStorageQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAttachmentStorageQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an attachment storage properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AttachmentStorageField[]</command:parameterValue> <dev:type> <maml:name>AttachmentStorageField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<AttachmentStorageQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<AttachmentStorageQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<AttachmentStorageQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an attachment storage properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AttachmentStorageField[]</command:parameterValue> <dev:type> <maml:name>AttachmentStorageField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<AttachmentStorageQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<AttachmentStorageQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<AttachmentStorageQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentStorageField[]</maml:name> </dev:type> <maml:description> <maml:para>The Attachment storage field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<AttachmentStorageQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment storage query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AttachmentStorageQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment storage query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAttachmentStorageQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentAttachmentStorageQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new attachment storage query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAttachmentStorageQueryFilter cmdlet creates and configures an attachment storage query filter object using the provided parameters. These filters can be used with the New-XurrentAttachmentStorageQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAttachmentStorageQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">DefaultFilter</command:parameterValue> <dev:type> <maml:name>DefaultFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">DefaultFilter</command:parameterValue> <dev:type> <maml:name>DefaultFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultFilter</maml:name> </dev:type> <maml:description> <maml:para>a default filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<AttachmentStorageQuery></maml:name> </dev:type> <maml:description> <maml:para>An attachment storage query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAutomationRule</command:name> <command:verb>New</command:verb> <command:noun>XurrentAutomationRule</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new automation rule.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates an automation rule using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAutomationRule</maml:name> <command:parameter required="true" position="0"> <maml:name>Condition</maml:name> <maml:description> <maml:para>The Condition field is used to define the condition that needs to be met in order for the update action(s) of the rule to be performed. For example: is_assigned and !badge.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the automation rule.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>The Trigger field is used to specify when the automation rule is to be triggered, for example on status update or on note added.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Actions</maml:name> <maml:description> <maml:para>The Actions field is used to define actions that should be executed when the condition of the automation rule is met.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleActionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the automation rule's function.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the automation rule should not be triggered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Expressions</maml:name> <maml:description> <maml:para>The Expressions field is used to define expressions that can subsequently be used to define the rule's conditions and the update action(s) that the rule is to perform.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleExpressionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Generic</maml:name> <maml:description> <maml:para>When the automation rule is not linked to one specific record but to all records of a type, the Generic field contains the record type. Valid values are:• request• problem• workflow• task• project_task• ci• risk• scim_user• scim_group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>The record that the automation rule is linked to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Position</maml:name> <maml:description> <maml:para>The Position field dictates the order in which the automation rule is executed.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of automation rule properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AutomationRuleField[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Condition</maml:name> <maml:description> <maml:para>The Condition field is used to define the condition that needs to be met in order for the update action(s) of the rule to be performed. For example: is_assigned and !badge.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the automation rule.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>The Trigger field is used to specify when the automation rule is to be triggered, for example on status update or on note added.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Actions</maml:name> <maml:description> <maml:para>The Actions field is used to define actions that should be executed when the condition of the automation rule is met.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleActionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the automation rule's function.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the automation rule should not be triggered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Expressions</maml:name> <maml:description> <maml:para>The Expressions field is used to define expressions that can subsequently be used to define the rule's conditions and the update action(s) that the rule is to perform.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleExpressionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Generic</maml:name> <maml:description> <maml:para>When the automation rule is not linked to one specific record but to all records of a type, the Generic field contains the record type. Valid values are:• request• problem• workflow• task• project_task• ci• risk• scim_user• scim_group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>The record that the automation rule is linked to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Position</maml:name> <maml:description> <maml:para>The Position field dictates the order in which the automation rule is executed.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of automation rule properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AutomationRuleField[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleActionInput[]</maml:name> </dev:type> <maml:description> <maml:para>An automation rule action input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleExpressionInput[]</maml:name> </dev:type> <maml:description> <maml:para>An automation rule expression input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleField[]</maml:name> </dev:type> <maml:description> <maml:para>The automation rule field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AutomationRule</maml:name> </dev:type> <maml:description> <maml:para>An automation rule object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAutomationRuleActionQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAutomationRuleActionQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an automation rule action query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAutomationRuleActionQuery cmdlet creates and configures an automation rule action query object using the provided parameters. These result can be used with the Invoke-XurrentAutomationRuleActionQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAutomationRuleActionQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an automation rule action properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AutomationRuleActionField[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an automation rule action properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AutomationRuleActionField[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleActionField[]</maml:name> </dev:type> <maml:description> <maml:para>The Automation rule action field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AutomationRuleActionQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule action query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAutomationRuleExpressionQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAutomationRuleExpressionQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an automation rule expression query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAutomationRuleExpressionQuery cmdlet creates and configures an automation rule expression query object using the provided parameters. These result can be used with the Invoke-XurrentAutomationRuleExpressionQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAutomationRuleExpressionQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an automation rule expression properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AutomationRuleExpressionField[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an automation rule expression properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AutomationRuleExpressionField[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleExpressionField[]</maml:name> </dev:type> <maml:description> <maml:para>The Automation rule expression field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AutomationRuleExpressionQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule expression query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAutomationRuleQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentAutomationRuleQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an automation rule query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAutomationRuleQuery cmdlet creates and configures an automation rule query object using the provided parameters. These result can be used with the Invoke-XurrentAutomationRuleQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAutomationRuleQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the automation rule query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an automation rule properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AutomationRuleField[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleView</command:parameterValue> <dev:type> <maml:name>AutomationRuleView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleOrderField</command:parameterValue> <dev:type> <maml:name>AutomationRuleOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Actions</maml:name> <maml:description> <maml:para>Specify the actions details to be returned using an automation rule action query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleActionQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Expressions</maml:name> <maml:description> <maml:para>Specify the expressions details to be returned using an automation rule expression query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleExpressionQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OwnerProjectTask</maml:name> <maml:description> <maml:para>Specify the owner Project task to be returned using a project task query. This only applies if the item is a project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>OwnerProjectTaskTemplate</maml:name> <maml:description> <maml:para>Specify the owner Project task template to be returned using a project task template query. This only applies if the item is a project task template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>OwnerProjectTaskTemplateRelation</maml:name> <maml:description> <maml:para>Specify the owner Project task template relation to be returned using a project task template relation query. This only applies if the item is a project task template relation.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateRelationQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateRelationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>OwnerRequest</maml:name> <maml:description> <maml:para>Specify the owner Request to be returned using a request query. This only applies if the item is a request.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>OwnerRequestTemplate</maml:name> <maml:description> <maml:para>Specify the owner Request template to be returned using a request template query. This only applies if the item is a request template.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>OwnerTask</maml:name> <maml:description> <maml:para>Specify the owner Task to be returned using a task query. This only applies if the item is a task.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>OwnerTaskTemplate</maml:name> <maml:description> <maml:para>Specify the owner Task template to be returned using a task template query. This only applies if the item is a task template.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>TaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>OwnerWorkflow</maml:name> <maml:description> <maml:para>Specify the owner Workflow to be returned using a workflow query. This only applies if the item is a workflow.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>OwnerWorkflowTaskTemplateRelation</maml:name> <maml:description> <maml:para>Specify the owner Workflow task template relation to be returned using a workflow task template relation query. This only applies if the item is a workflow task template relation.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTaskTemplateRelationQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTaskTemplateRelationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>OwnerWorkflowTemplate</maml:name> <maml:description> <maml:para>Specify the owner Workflow template to be returned using a workflow template query. This only applies if the item is a workflow template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<AutomationRuleQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<AutomationRuleQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<AutomationRuleQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the automation rule query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an automation rule properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AutomationRuleField[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleView</command:parameterValue> <dev:type> <maml:name>AutomationRuleView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleOrderField</command:parameterValue> <dev:type> <maml:name>AutomationRuleOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Actions</maml:name> <maml:description> <maml:para>Specify the actions details to be returned using an automation rule action query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleActionQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Expressions</maml:name> <maml:description> <maml:para>Specify the expressions details to be returned using an automation rule expression query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleExpressionQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OwnerProjectTask</maml:name> <maml:description> <maml:para>Specify the owner Project task to be returned using a project task query. This only applies if the item is a project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>OwnerProjectTaskTemplate</maml:name> <maml:description> <maml:para>Specify the owner Project task template to be returned using a project task template query. This only applies if the item is a project task template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>OwnerProjectTaskTemplateRelation</maml:name> <maml:description> <maml:para>Specify the owner Project task template relation to be returned using a project task template relation query. This only applies if the item is a project task template relation.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateRelationQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateRelationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>OwnerRequest</maml:name> <maml:description> <maml:para>Specify the owner Request to be returned using a request query. This only applies if the item is a request.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>OwnerRequestTemplate</maml:name> <maml:description> <maml:para>Specify the owner Request template to be returned using a request template query. This only applies if the item is a request template.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>OwnerTask</maml:name> <maml:description> <maml:para>Specify the owner Task to be returned using a task query. This only applies if the item is a task.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>OwnerTaskTemplate</maml:name> <maml:description> <maml:para>Specify the owner Task template to be returned using a task template query. This only applies if the item is a task template.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>TaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>OwnerWorkflow</maml:name> <maml:description> <maml:para>Specify the owner Workflow to be returned using a workflow query. This only applies if the item is a workflow.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>OwnerWorkflowTaskTemplateRelation</maml:name> <maml:description> <maml:para>Specify the owner Workflow task template relation to be returned using a workflow task template relation query. This only applies if the item is a workflow task template relation.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTaskTemplateRelationQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTaskTemplateRelationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>OwnerWorkflowTemplate</maml:name> <maml:description> <maml:para>Specify the owner Workflow template to be returned using a workflow template query. This only applies if the item is a workflow template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<AutomationRuleQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<AutomationRuleQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<AutomationRuleQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleField[]</maml:name> </dev:type> <maml:description> <maml:para>The Automation rule field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleView</maml:name> </dev:type> <maml:description> <maml:para>The automation rule view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleOrderField</maml:name> </dev:type> <maml:description> <maml:para>The automation rule order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleActionQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule action query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleExpressionQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule expression query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateRelationQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task template relation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A request template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A task template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTaskTemplateRelationQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow task template relation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<AutomationRuleQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentAutomationRuleQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentAutomationRuleQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new automation rule query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentAutomationRuleQueryFilter cmdlet creates and configures an automation rule query filter object using the provided parameters. These filters can be used with the New-XurrentAutomationRuleQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentAutomationRuleQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">AutomationRuleFilter</command:parameterValue> <dev:type> <maml:name>AutomationRuleFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">AutomationRuleFilter</command:parameterValue> <dev:type> <maml:name>AutomationRuleFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleFilter</maml:name> </dev:type> <maml:description> <maml:para>an automation rule filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<AutomationRuleQuery></maml:name> </dev:type> <maml:description> <maml:para>An automation rule query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentBroadcast</command:name> <command:verb>New</command:verb> <command:noun>XurrentBroadcast</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new broadcast.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a broadcast using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentBroadcast</maml:name> <command:parameter required="true" position="0"> <maml:name>MessageType</maml:name> <maml:description> <maml:para>The appropriate icon for the message. The selected icon is displayed alongside the message when the broadcast is presented.</maml:para> </maml:description> <command:parameterValue required="true">BroadcastMessageType</command:parameterValue> <dev:type> <maml:name>BroadcastMessageType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Body</maml:name> <maml:description> <maml:para>The body for the email broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerIds</maml:name> <maml:description> <maml:para>The customer organizations when the broadcast is to be displayed for the specialists of the account in requests that were received from the selected organizations. This is available only when the "Specialists in requests from the following customers" visibility option is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the message should not be broadcasted.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EmailTemplateId</maml:name> <maml:description> <maml:para>The id of the email template used for the email broadcast. This email template needs to be of the type Send Email from Broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>The end date and time of the broadcast. This field is left empty when the message is to be broadcasted until the Disabled box is checked. (If the broadcast should end at midnight at the end of a day, specify 12:00am or 24:00.)</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Message</maml:name> <maml:description> <maml:para>Message that is to be broadcasted in the language of the account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>The ids of the organizations, to which people belong, that need to see the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the broadcast that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Files and inline images linked to the Remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>The request group to which end users can subscribe when they are also affected by the issue for which the broadcast was created.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>The service instances for which the people, who are covered for them by an active SLA, need to see the broadcast. This is available only when the "People covered for the following service instance(s)" visibility option is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SiteIds</maml:name> <maml:description> <maml:para>The ids of the sites to which people belong and that need to see the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>The ids of the skill pools to which people belong and that need to see the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SlaIds</maml:name> <maml:description> <maml:para>The ids of the service level agreements for which the customer representatives will receive the email broadcast. This is only available for broadcasts when the message type "email" is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The start date and time of the broadcast. (If the broadcast should start at midnight at the start of a day, specify 00:00.)</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Subject</maml:name> <maml:description> <maml:para>The subject for the email broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TeamIds</maml:name> <maml:description> <maml:para>The teams which members need to see the broadcast. This is available only when the "Members of the following team(s)" visibility option is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the dates and times specified in the Start and End fields.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Defines the target audience of the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">BroadcastVisibility</command:parameterValue> <dev:type> <maml:name>BroadcastVisibility</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="23"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of broadcast properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BroadcastField[]</command:parameterValue> <dev:type> <maml:name>BroadcastField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>MessageType</maml:name> <maml:description> <maml:para>The appropriate icon for the message. The selected icon is displayed alongside the message when the broadcast is presented.</maml:para> </maml:description> <command:parameterValue required="true">BroadcastMessageType</command:parameterValue> <dev:type> <maml:name>BroadcastMessageType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Body</maml:name> <maml:description> <maml:para>The body for the email broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerIds</maml:name> <maml:description> <maml:para>The customer organizations when the broadcast is to be displayed for the specialists of the account in requests that were received from the selected organizations. This is available only when the "Specialists in requests from the following customers" visibility option is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the message should not be broadcasted.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EmailTemplateId</maml:name> <maml:description> <maml:para>The id of the email template used for the email broadcast. This email template needs to be of the type Send Email from Broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>The end date and time of the broadcast. This field is left empty when the message is to be broadcasted until the Disabled box is checked. (If the broadcast should end at midnight at the end of a day, specify 12:00am or 24:00.)</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Message</maml:name> <maml:description> <maml:para>Message that is to be broadcasted in the language of the account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>The ids of the organizations, to which people belong, that need to see the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the broadcast that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Files and inline images linked to the Remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>The request group to which end users can subscribe when they are also affected by the issue for which the broadcast was created.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>The service instances for which the people, who are covered for them by an active SLA, need to see the broadcast. This is available only when the "People covered for the following service instance(s)" visibility option is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SiteIds</maml:name> <maml:description> <maml:para>The ids of the sites to which people belong and that need to see the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>The ids of the skill pools to which people belong and that need to see the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SlaIds</maml:name> <maml:description> <maml:para>The ids of the service level agreements for which the customer representatives will receive the email broadcast. This is only available for broadcasts when the message type "email" is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The start date and time of the broadcast. (If the broadcast should start at midnight at the start of a day, specify 00:00.)</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Subject</maml:name> <maml:description> <maml:para>The subject for the email broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TeamIds</maml:name> <maml:description> <maml:para>The teams which members need to see the broadcast. This is available only when the "Members of the following team(s)" visibility option is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the dates and times specified in the Start and End fields.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Defines the target audience of the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">BroadcastVisibility</command:parameterValue> <dev:type> <maml:name>BroadcastVisibility</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="23"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of broadcast properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BroadcastField[]</command:parameterValue> <dev:type> <maml:name>BroadcastField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.BroadcastMessageType</maml:name> </dev:type> <maml:description> <maml:para>A broadcast message type object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.BroadcastVisibility</maml:name> </dev:type> <maml:description> <maml:para>A broadcast visibility object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.BroadcastField[]</maml:name> </dev:type> <maml:description> <maml:para>The broadcast field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Broadcast</maml:name> </dev:type> <maml:description> <maml:para>A broadcast object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentBroadcastQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentBroadcastQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a broadcast query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentBroadcastQuery cmdlet creates and configures a broadcast query object using the provided parameters. These result can be used with the Invoke-XurrentBroadcastQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentBroadcastQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the broadcast query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a broadcast properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BroadcastField[]</command:parameterValue> <dev:type> <maml:name>BroadcastField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Customers</maml:name> <maml:description> <maml:para>Specify the customers details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>EmailTemplate</maml:name> <maml:description> <maml:para>Specify the email template details to be returned using an email template query.</maml:para> </maml:description> <command:parameterValue required="false">EmailTemplateQuery</command:parameterValue> <dev:type> <maml:name>EmailTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Organizations</maml:name> <maml:description> <maml:para>Specify the organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Request</maml:name> <maml:description> <maml:para>Specify the request details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Sites</maml:name> <maml:description> <maml:para>Specify the sites details to be returned using a site query.</maml:para> </maml:description> <command:parameterValue required="false">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SkillPools</maml:name> <maml:description> <maml:para>Specify the skill pools details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Slas</maml:name> <maml:description> <maml:para>Specify the SLAs details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Teams</maml:name> <maml:description> <maml:para>Specify the teams details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a broadcast translation query.</maml:para> </maml:description> <command:parameterValue required="false">BroadcastTranslationQuery</command:parameterValue> <dev:type> <maml:name>BroadcastTranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<BroadcastQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<BroadcastQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<BroadcastQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the broadcast query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a broadcast properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BroadcastField[]</command:parameterValue> <dev:type> <maml:name>BroadcastField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Customers</maml:name> <maml:description> <maml:para>Specify the customers details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>EmailTemplate</maml:name> <maml:description> <maml:para>Specify the email template details to be returned using an email template query.</maml:para> </maml:description> <command:parameterValue required="false">EmailTemplateQuery</command:parameterValue> <dev:type> <maml:name>EmailTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Organizations</maml:name> <maml:description> <maml:para>Specify the organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Request</maml:name> <maml:description> <maml:para>Specify the request details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Sites</maml:name> <maml:description> <maml:para>Specify the sites details to be returned using a site query.</maml:para> </maml:description> <command:parameterValue required="false">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SkillPools</maml:name> <maml:description> <maml:para>Specify the skill pools details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Slas</maml:name> <maml:description> <maml:para>Specify the SLAs details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Teams</maml:name> <maml:description> <maml:para>Specify the teams details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a broadcast translation query.</maml:para> </maml:description> <command:parameterValue required="false">BroadcastTranslationQuery</command:parameterValue> <dev:type> <maml:name>BroadcastTranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<BroadcastQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<BroadcastQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<BroadcastQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.BroadcastField[]</maml:name> </dev:type> <maml:description> <maml:para>The Broadcast field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EmailTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>An email template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SiteQuery</maml:name> </dev:type> <maml:description> <maml:para>A site query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolQuery</maml:name> </dev:type> <maml:description> <maml:para>A skill pool query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.BroadcastTranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A broadcast translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<BroadcastQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A broadcast query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BroadcastQuery</maml:name> </dev:type> <maml:description> <maml:para>A broadcast query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentBroadcastQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentBroadcastQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new broadcast query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentBroadcastQueryFilter cmdlet creates and configures a broadcast query filter object using the provided parameters. These filters can be used with the New-XurrentBroadcastQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentBroadcastQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">BroadcastFilter</command:parameterValue> <dev:type> <maml:name>BroadcastFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">BroadcastFilter</command:parameterValue> <dev:type> <maml:name>BroadcastFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.BroadcastFilter</maml:name> </dev:type> <maml:description> <maml:para>a broadcast filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<BroadcastQuery></maml:name> </dev:type> <maml:description> <maml:para>A broadcast query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentBroadcastTranslationQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentBroadcastTranslationQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a broadcast translation query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentBroadcastTranslationQuery cmdlet creates and configures a broadcast translation query object using the provided parameters. These result can be used with the Invoke-XurrentBroadcastTranslationQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentBroadcastTranslationQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a broadcast translation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BroadcastTranslationField[]</command:parameterValue> <dev:type> <maml:name>BroadcastTranslationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>MessageAttachments</maml:name> <maml:description> <maml:para>Specify the message attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a broadcast translation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BroadcastTranslationField[]</command:parameterValue> <dev:type> <maml:name>BroadcastTranslationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>MessageAttachments</maml:name> <maml:description> <maml:para>Specify the message attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.BroadcastTranslationField[]</maml:name> </dev:type> <maml:description> <maml:para>The Broadcast translation field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BroadcastTranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A broadcast translation query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentCalendar</command:name> <command:verb>New</command:verb> <command:noun>XurrentCalendar</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new calendar.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a calendar using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentCalendar</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the calendar.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the calendar may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>HolidayIds</maml:name> <maml:description> <maml:para>Identifiers of the holidays of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewCalendarHours</maml:name> <maml:description> <maml:para>Calendar hours of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">CalendarHoursInput[]</command:parameterValue> <dev:type> <maml:name>CalendarHoursInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="7"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of calendar properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CalendarField[]</command:parameterValue> <dev:type> <maml:name>CalendarField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the calendar.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the calendar may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>HolidayIds</maml:name> <maml:description> <maml:para>Identifiers of the holidays of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewCalendarHours</maml:name> <maml:description> <maml:para>Calendar hours of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">CalendarHoursInput[]</command:parameterValue> <dev:type> <maml:name>CalendarHoursInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="7"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of calendar properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CalendarField[]</command:parameterValue> <dev:type> <maml:name>CalendarField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarHoursInput[]</maml:name> </dev:type> <maml:description> <maml:para>A calendar hours input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarField[]</maml:name> </dev:type> <maml:description> <maml:para>The calendar field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Calendar</maml:name> </dev:type> <maml:description> <maml:para>A calendar object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentCalendarHourQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentCalendarHourQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a calendar hour query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentCalendarHourQuery cmdlet creates and configures a calendar hour query object using the provided parameters. These result can be used with the Invoke-XurrentCalendarHourQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentCalendarHourQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a calendar hour properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CalendarHourField[]</command:parameterValue> <dev:type> <maml:name>CalendarHourField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a calendar hour properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CalendarHourField[]</command:parameterValue> <dev:type> <maml:name>CalendarHourField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarHourField[]</maml:name> </dev:type> <maml:description> <maml:para>The Calendar hour field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CalendarHourQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar hour query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentCalendarQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentCalendarQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a calendar query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentCalendarQuery cmdlet creates and configures a calendar query object using the provided parameters. These result can be used with the Invoke-XurrentCalendarQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentCalendarQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the calendar query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a calendar properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CalendarField[]</command:parameterValue> <dev:type> <maml:name>CalendarField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CalendarHours</maml:name> <maml:description> <maml:para>Specify the calendar hours details to be returned using a calendar hour query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarHourQuery</command:parameterValue> <dev:type> <maml:name>CalendarHourQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Holidays</maml:name> <maml:description> <maml:para>Specify the holidays details to be returned using a holiday query.</maml:para> </maml:description> <command:parameterValue required="false">HolidayQuery</command:parameterValue> <dev:type> <maml:name>HolidayQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<CalendarQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<CalendarQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<CalendarQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the calendar query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a calendar properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CalendarField[]</command:parameterValue> <dev:type> <maml:name>CalendarField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CalendarHours</maml:name> <maml:description> <maml:para>Specify the calendar hours details to be returned using a calendar hour query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarHourQuery</command:parameterValue> <dev:type> <maml:name>CalendarHourQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Holidays</maml:name> <maml:description> <maml:para>Specify the holidays details to be returned using a holiday query.</maml:para> </maml:description> <command:parameterValue required="false">HolidayQuery</command:parameterValue> <dev:type> <maml:name>HolidayQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<CalendarQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<CalendarQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<CalendarQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarField[]</maml:name> </dev:type> <maml:description> <maml:para>The Calendar field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarHourQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar hour query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.HolidayQuery</maml:name> </dev:type> <maml:description> <maml:para>A holiday query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<CalendarQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A calendar query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentCalendarQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentCalendarQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new calendar query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentCalendarQueryFilter cmdlet creates and configures a calendar query filter object using the provided parameters. These filters can be used with the New-XurrentCalendarQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentCalendarQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">CalendarFilter</command:parameterValue> <dev:type> <maml:name>CalendarFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">CalendarFilter</command:parameterValue> <dev:type> <maml:name>CalendarFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarFilter</maml:name> </dev:type> <maml:description> <maml:para>a calendar filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<CalendarQuery></maml:name> </dev:type> <maml:description> <maml:para>A calendar query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentClient</command:name> <command:verb>New</command:verb> <command:noun>XurrentClient</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a Xurrent connection.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentClient</maml:name> <command:parameter required="true" position="2"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>The personal access token for authentication.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>The Xurrent account identifier.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>EnvironmentType</maml:name> <maml:description> <maml:para>The Xurrent environment.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentType</command:parameterValue> <dev:type> <maml:name>EnvironmentType</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="6"> <maml:name>EnvironmentRegion</maml:name> <maml:description> <maml:para>The Xurrent region.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentRegion</command:parameterValue> <dev:type> <maml:name>EnvironmentRegion</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaximumRecursiveRequests</maml:name> <maml:description> <maml:para>The maximum number of recursive requests allowed. Default is 10 when not specified, with a minimum value of 1 and a maximum value of 1000.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaximumQueryDepthLevelConnections</maml:name> <maml:description> <maml:para>The maximum query depth for connections. Default is 2 when not specified, with a minimum value of 1 and a maximum value of 13.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DefaultItemsPerRequest</maml:name> <maml:description> <maml:para>The default number of items per request is 100 when not specified, with a minimum value of 1 and a maximum value of 100.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EnumeratorTolerantSerializer</maml:name> <maml:description> <maml:para>Indicates whether the serializer should be tolerant to enumerators. Default is true when not specified.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-XurrentClient</maml:name> <command:parameter required="true" position="0"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The client ID for OAuth authentication.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>The client secret for OAuth authentication.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>The Xurrent account identifier.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>EnvironmentType</maml:name> <maml:description> <maml:para>The Xurrent environment.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentType</command:parameterValue> <dev:type> <maml:name>EnvironmentType</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="6"> <maml:name>EnvironmentRegion</maml:name> <maml:description> <maml:para>The Xurrent region.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentRegion</command:parameterValue> <dev:type> <maml:name>EnvironmentRegion</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaximumRecursiveRequests</maml:name> <maml:description> <maml:para>The maximum number of recursive requests allowed. Default is 10 when not specified, with a minimum value of 1 and a maximum value of 1000.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaximumQueryDepthLevelConnections</maml:name> <maml:description> <maml:para>The maximum query depth for connections. Default is 2 when not specified, with a minimum value of 1 and a maximum value of 13.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DefaultItemsPerRequest</maml:name> <maml:description> <maml:para>The default number of items per request is 100 when not specified, with a minimum value of 1 and a maximum value of 100.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EnumeratorTolerantSerializer</maml:name> <maml:description> <maml:para>Indicates whether the serializer should be tolerant to enumerators. Default is true when not specified.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-XurrentClient</maml:name> <command:parameter required="true" position="3"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials for authentication.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>The Xurrent account identifier.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>EnvironmentType</maml:name> <maml:description> <maml:para>The Xurrent environment.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentType</command:parameterValue> <dev:type> <maml:name>EnvironmentType</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="6"> <maml:name>EnvironmentRegion</maml:name> <maml:description> <maml:para>The Xurrent region.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentRegion</command:parameterValue> <dev:type> <maml:name>EnvironmentRegion</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaximumRecursiveRequests</maml:name> <maml:description> <maml:para>The maximum number of recursive requests allowed. Default is 10 when not specified, with a minimum value of 1 and a maximum value of 1000.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaximumQueryDepthLevelConnections</maml:name> <maml:description> <maml:para>The maximum query depth for connections. Default is 2 when not specified, with a minimum value of 1 and a maximum value of 13.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DefaultItemsPerRequest</maml:name> <maml:description> <maml:para>The default number of items per request is 100 when not specified, with a minimum value of 1 and a maximum value of 100.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EnumeratorTolerantSerializer</maml:name> <maml:description> <maml:para>Indicates whether the serializer should be tolerant to enumerators. Default is true when not specified.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The client ID for OAuth authentication.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>The client secret for OAuth authentication.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials for authentication.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>The personal access token for authentication.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>The Xurrent account identifier.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>EnvironmentType</maml:name> <maml:description> <maml:para>The Xurrent environment.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentType</command:parameterValue> <dev:type> <maml:name>EnvironmentType</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="6"> <maml:name>EnvironmentRegion</maml:name> <maml:description> <maml:para>The Xurrent region.</maml:para> </maml:description> <command:parameterValue required="true">EnvironmentRegion</command:parameterValue> <dev:type> <maml:name>EnvironmentRegion</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaximumRecursiveRequests</maml:name> <maml:description> <maml:para>The maximum number of recursive requests allowed. Default is 10 when not specified, with a minimum value of 1 and a maximum value of 1000.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaximumQueryDepthLevelConnections</maml:name> <maml:description> <maml:para>The maximum query depth for connections. Default is 2 when not specified, with a minimum value of 1 and a maximum value of 13.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DefaultItemsPerRequest</maml:name> <maml:description> <maml:para>The default number of items per request is 100 when not specified, with a minimum value of 1 and a maximum value of 100.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EnumeratorTolerantSerializer</maml:name> <maml:description> <maml:para>Indicates whether the serializer should be tolerant to enumerators. Default is true when not specified.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EnvironmentRegion</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent environment region.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EnvironmentType</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent environment type.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> </dev:type> <maml:description> <maml:para>A PowerShell Credential object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The client for interacting with the Xurrent API.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentConfigurationItem</command:name> <command:verb>New</command:verb> <command:noun>XurrentConfigurationItem</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new configuration item.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a configuration item using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentConfigurationItem</maml:name> <command:parameter required="true" position="0"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of the related product.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Status</maml:name> <maml:description> <maml:para>The appropriate status for the configuration item (CI).</maml:para> </maml:description> <command:parameterValue required="true">CiStatus</command:parameterValue> <dev:type> <maml:name>CiStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AlternateNames</maml:name> <maml:description> <maml:para>Alternate names the configuration item is also known by.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AssetID</maml:name> <maml:description> <maml:para>Asset identifier of the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ContractIds</maml:name> <maml:description> <maml:para>Identifiers of the contracts of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>EndOfSupportDate</maml:name> <maml:description> <maml:para>The date at which the support for this configuration item ends.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>FinancialOwnerId</maml:name> <maml:description> <maml:para>Identifier of the internal organization which budget is used to pay for the configuration item. If the CI is leased or rented, the organization that pays the lease or rent is selected in this field. When creating a new CI and a value is not specified for this field, it is set to the financial owner of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>InUseSince</maml:name> <maml:description> <maml:para>The date on which the expense for the configuration item (CI) was incurred or, if the CI is depreciated over time, the date on which the depreciation was started. This is typically the invoice date.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Label</maml:name> <maml:description> <maml:para>The label that is attached to the configuration item (CI). A label is automatically generated using the same prefix of other CIs of the same product category, followed by the next available number as the suffix.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>LastSeenAt</maml:name> <maml:description> <maml:para>The date and time at which the configuration item was last seen.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>LicensedSiteIds</maml:name> <maml:description> <maml:para>Identifiers of the sites at which the software that is covered by the license certificate may be used.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>LicenseExpiryDate</maml:name> <maml:description> <maml:para>The date through which the temporary software license certificate is valid. The license certificate expires at the end of this day.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>LicenseType</maml:name> <maml:description> <maml:para>The type of license that the license certificate covers.</maml:para> </maml:description> <command:parameterValue required="false">CiLicenseType</command:parameterValue> <dev:type> <maml:name>CiLicenseType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Location</maml:name> <maml:description> <maml:para>The name or number of the room in which the CI is located, if it concerns a hardware CI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the configuration item (CI). When creating a new CI and a value is not specified for this field, it is set to the name of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>NewCiRelations</maml:name> <maml:description> <maml:para>Relations to other configuration items.</maml:para> </maml:description> <command:parameterValue required="false">CiRelationInput[]</command:parameterValue> <dev:type> <maml:name>CiRelationInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>NrOfCores</maml:name> <maml:description> <maml:para>The total number of processor cores that are installed in the server.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>NrOfLicenses</maml:name> <maml:description> <maml:para>The number of licenses that the license certificate covers.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>NrOfProcessors</maml:name> <maml:description> <maml:para>The number of processors that are installed in the server.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>OperatingSystemId</maml:name> <maml:description> <maml:para>Identifier of the (software) configuration item representing the operating system of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>PurchaseValue</maml:name> <maml:description> <maml:para>The amount that was paid for the configuration item (this is normally equal to the invoice amount).</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>PurchaseValueCurrency</maml:name> <maml:description> <maml:para>The currency of the purchase value attributed to this configuration item.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>RamAmount</maml:name> <maml:description> <maml:para>The amount of RAM (in GB) of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for maintenance of the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceInput</command:parameterValue> <dev:type> <maml:name>RecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the configuration item that might prove useful. When creating a new CI and a value is not specified for this field, it is set to the remarks of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>RuleSet</maml:name> <maml:description> <maml:para>The Rule set field is automatically set to the rule set of product category, except when the CI is a license certificate, in which case the rule set is license_certificate.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryRuleSet</command:parameterValue> <dev:type> <maml:name>ProductCategoryRuleSet</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>SerialNr</maml:name> <maml:description> <maml:para>Serial number of the configuration item. The concatenation of product's' brand and serialNr must be unique within a Xurrent account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Which service instance(s) the configuration item is, or will be, a part of. When creating a new CI and a value is not specified for this field, it is set to the service of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of the service instances of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SiteId</maml:name> <maml:description> <maml:para>Where the CI is located, if it concerns a hardware CI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>SiteLicense</maml:name> <maml:description> <maml:para>true for license certificates that may only be used at one or more specific locations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier from which the configuration item (CI) has been obtained. When creating a new CI and a value is not specified for this field, it is set to the supplier of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team responsible for supporting the configuration item and maintaining its information in the configuration management database (CMDB). When creating a new CI and a value is not specified for this field, it is set to the support team of the CI's product. Optional when status of CI equals "Removed", required otherwise.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>SystemID</maml:name> <maml:description> <maml:para>System identifier of the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>TemporaryLicense</maml:name> <maml:description> <maml:para>true for license certificates that are not valid indefinitely.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>UserIds</maml:name> <maml:description> <maml:para>Identifiers of the users of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>WarrantyExpiryDate</maml:name> <maml:description> <maml:para>The date through which the warranty coverage for the configuration item is valid. The warranty expires at the end of this day.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>The person who will be responsible for coordinating the workflows that will be generated automatically in accordance with the recurrence schedule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>WorkflowTemplateId</maml:name> <maml:description> <maml:para>The workflow template that is used to periodically maintain the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="46"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of configuration item properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ConfigurationItemField[]</command:parameterValue> <dev:type> <maml:name>ConfigurationItemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="47"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of the related product.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Status</maml:name> <maml:description> <maml:para>The appropriate status for the configuration item (CI).</maml:para> </maml:description> <command:parameterValue required="true">CiStatus</command:parameterValue> <dev:type> <maml:name>CiStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AlternateNames</maml:name> <maml:description> <maml:para>Alternate names the configuration item is also known by.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AssetID</maml:name> <maml:description> <maml:para>Asset identifier of the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ContractIds</maml:name> <maml:description> <maml:para>Identifiers of the contracts of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>EndOfSupportDate</maml:name> <maml:description> <maml:para>The date at which the support for this configuration item ends.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>FinancialOwnerId</maml:name> <maml:description> <maml:para>Identifier of the internal organization which budget is used to pay for the configuration item. If the CI is leased or rented, the organization that pays the lease or rent is selected in this field. When creating a new CI and a value is not specified for this field, it is set to the financial owner of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>InUseSince</maml:name> <maml:description> <maml:para>The date on which the expense for the configuration item (CI) was incurred or, if the CI is depreciated over time, the date on which the depreciation was started. This is typically the invoice date.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Label</maml:name> <maml:description> <maml:para>The label that is attached to the configuration item (CI). A label is automatically generated using the same prefix of other CIs of the same product category, followed by the next available number as the suffix.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>LastSeenAt</maml:name> <maml:description> <maml:para>The date and time at which the configuration item was last seen.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>LicensedSiteIds</maml:name> <maml:description> <maml:para>Identifiers of the sites at which the software that is covered by the license certificate may be used.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>LicenseExpiryDate</maml:name> <maml:description> <maml:para>The date through which the temporary software license certificate is valid. The license certificate expires at the end of this day.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>LicenseType</maml:name> <maml:description> <maml:para>The type of license that the license certificate covers.</maml:para> </maml:description> <command:parameterValue required="false">CiLicenseType</command:parameterValue> <dev:type> <maml:name>CiLicenseType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Location</maml:name> <maml:description> <maml:para>The name or number of the room in which the CI is located, if it concerns a hardware CI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the configuration item (CI). When creating a new CI and a value is not specified for this field, it is set to the name of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>NewCiRelations</maml:name> <maml:description> <maml:para>Relations to other configuration items.</maml:para> </maml:description> <command:parameterValue required="false">CiRelationInput[]</command:parameterValue> <dev:type> <maml:name>CiRelationInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>NrOfCores</maml:name> <maml:description> <maml:para>The total number of processor cores that are installed in the server.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>NrOfLicenses</maml:name> <maml:description> <maml:para>The number of licenses that the license certificate covers.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>NrOfProcessors</maml:name> <maml:description> <maml:para>The number of processors that are installed in the server.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>OperatingSystemId</maml:name> <maml:description> <maml:para>Identifier of the (software) configuration item representing the operating system of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>PurchaseValue</maml:name> <maml:description> <maml:para>The amount that was paid for the configuration item (this is normally equal to the invoice amount).</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>PurchaseValueCurrency</maml:name> <maml:description> <maml:para>The currency of the purchase value attributed to this configuration item.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>RamAmount</maml:name> <maml:description> <maml:para>The amount of RAM (in GB) of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for maintenance of the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceInput</command:parameterValue> <dev:type> <maml:name>RecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the configuration item that might prove useful. When creating a new CI and a value is not specified for this field, it is set to the remarks of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>RuleSet</maml:name> <maml:description> <maml:para>The Rule set field is automatically set to the rule set of product category, except when the CI is a license certificate, in which case the rule set is license_certificate.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryRuleSet</command:parameterValue> <dev:type> <maml:name>ProductCategoryRuleSet</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>SerialNr</maml:name> <maml:description> <maml:para>Serial number of the configuration item. The concatenation of product's' brand and serialNr must be unique within a Xurrent account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Which service instance(s) the configuration item is, or will be, a part of. When creating a new CI and a value is not specified for this field, it is set to the service of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of the service instances of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SiteId</maml:name> <maml:description> <maml:para>Where the CI is located, if it concerns a hardware CI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>SiteLicense</maml:name> <maml:description> <maml:para>true for license certificates that may only be used at one or more specific locations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier from which the configuration item (CI) has been obtained. When creating a new CI and a value is not specified for this field, it is set to the supplier of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team responsible for supporting the configuration item and maintaining its information in the configuration management database (CMDB). When creating a new CI and a value is not specified for this field, it is set to the support team of the CI's product. Optional when status of CI equals "Removed", required otherwise.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>SystemID</maml:name> <maml:description> <maml:para>System identifier of the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>TemporaryLicense</maml:name> <maml:description> <maml:para>true for license certificates that are not valid indefinitely.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>UserIds</maml:name> <maml:description> <maml:para>Identifiers of the users of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>WarrantyExpiryDate</maml:name> <maml:description> <maml:para>The date through which the warranty coverage for the configuration item is valid. The warranty expires at the end of this day.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>The person who will be responsible for coordinating the workflows that will be generated automatically in accordance with the recurrence schedule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>WorkflowTemplateId</maml:name> <maml:description> <maml:para>The workflow template that is used to periodically maintain the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="46"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of configuration item properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ConfigurationItemField[]</command:parameterValue> <dev:type> <maml:name>ConfigurationItemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="47"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CiStatus</maml:name> </dev:type> <maml:description> <maml:para>A ci status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CiLicenseType</maml:name> </dev:type> <maml:description> <maml:para>A ci license type object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CiRelationInput[]</maml:name> </dev:type> <maml:description> <maml:para>A ci relation input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecurrenceInput</maml:name> </dev:type> <maml:description> <maml:para>A recurrence input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductCategoryRuleSet</maml:name> </dev:type> <maml:description> <maml:para>A product category rule set object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemField[]</maml:name> </dev:type> <maml:description> <maml:para>The configuration item field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ConfigurationItem</maml:name> </dev:type> <maml:description> <maml:para>A configuration item object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentConfigurationItemQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentConfigurationItemQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a configuration item query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentConfigurationItemQuery cmdlet creates and configures a configuration item query object using the provided parameters. These result can be used with the Invoke-XurrentConfigurationItemQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentConfigurationItemQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the configuration item query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a configuration item properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ConfigurationItemField[]</command:parameterValue> <dev:type> <maml:name>ConfigurationItemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemView</command:parameterValue> <dev:type> <maml:name>ConfigurationItemView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemOrderField</command:parameterValue> <dev:type> <maml:name>ConfigurationItemOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CiRelations</maml:name> <maml:description> <maml:para>Specify the ci relations details to be returned using a configuration item relation query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemRelationQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemRelationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Contracts</maml:name> <maml:description> <maml:para>Specify the contracts details to be returned using a contract query.</maml:para> </maml:description> <command:parameterValue required="false">ContractQuery</command:parameterValue> <dev:type> <maml:name>ContractQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FinancialOwner</maml:name> <maml:description> <maml:para>Specify the financial owner details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Invoices</maml:name> <maml:description> <maml:para>Specify the invoices details to be returned using an invoice query.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>LicensedSites</maml:name> <maml:description> <maml:para>Specify the licensed sites details to be returned using a site query.</maml:para> </maml:description> <command:parameterValue required="false">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>OperatingSystem</maml:name> <maml:description> <maml:para>Specify the operating system details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Problems</maml:name> <maml:description> <maml:para>Specify the problems details to be returned using a problem query.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Product</maml:name> <maml:description> <maml:para>Specify the product details to be returned using a product query.</maml:para> </maml:description> <command:parameterValue required="false">ProductQuery</command:parameterValue> <dev:type> <maml:name>ProductQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Specify the recurrence details to be returned using a recurrence query.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceQuery</command:parameterValue> <dev:type> <maml:name>RecurrenceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Requests</maml:name> <maml:description> <maml:para>Specify the requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Site</maml:name> <maml:description> <maml:para>Specify the site details to be returned using a site query.</maml:para> </maml:description> <command:parameterValue required="false">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>SupportAccount</maml:name> <maml:description> <maml:para>Specify the support account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SupportTeam</maml:name> <maml:description> <maml:para>Specify the support team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Users</maml:name> <maml:description> <maml:para>Specify the users details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>WorkflowManager</maml:name> <maml:description> <maml:para>Specify the workflow manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>WorkflowTemplate</maml:name> <maml:description> <maml:para>Specify the workflow template details to be returned using a workflow template query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ConfigurationItemQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ConfigurationItemQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ConfigurationItemQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the configuration item query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a configuration item properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ConfigurationItemField[]</command:parameterValue> <dev:type> <maml:name>ConfigurationItemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemView</command:parameterValue> <dev:type> <maml:name>ConfigurationItemView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemOrderField</command:parameterValue> <dev:type> <maml:name>ConfigurationItemOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CiRelations</maml:name> <maml:description> <maml:para>Specify the ci relations details to be returned using a configuration item relation query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemRelationQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemRelationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Contracts</maml:name> <maml:description> <maml:para>Specify the contracts details to be returned using a contract query.</maml:para> </maml:description> <command:parameterValue required="false">ContractQuery</command:parameterValue> <dev:type> <maml:name>ContractQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FinancialOwner</maml:name> <maml:description> <maml:para>Specify the financial owner details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Invoices</maml:name> <maml:description> <maml:para>Specify the invoices details to be returned using an invoice query.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>LicensedSites</maml:name> <maml:description> <maml:para>Specify the licensed sites details to be returned using a site query.</maml:para> </maml:description> <command:parameterValue required="false">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>OperatingSystem</maml:name> <maml:description> <maml:para>Specify the operating system details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Problems</maml:name> <maml:description> <maml:para>Specify the problems details to be returned using a problem query.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Product</maml:name> <maml:description> <maml:para>Specify the product details to be returned using a product query.</maml:para> </maml:description> <command:parameterValue required="false">ProductQuery</command:parameterValue> <dev:type> <maml:name>ProductQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Specify the recurrence details to be returned using a recurrence query.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceQuery</command:parameterValue> <dev:type> <maml:name>RecurrenceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Requests</maml:name> <maml:description> <maml:para>Specify the requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Site</maml:name> <maml:description> <maml:para>Specify the site details to be returned using a site query.</maml:para> </maml:description> <command:parameterValue required="false">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>SupportAccount</maml:name> <maml:description> <maml:para>Specify the support account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SupportTeam</maml:name> <maml:description> <maml:para>Specify the support team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Users</maml:name> <maml:description> <maml:para>Specify the users details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>WorkflowManager</maml:name> <maml:description> <maml:para>Specify the workflow manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>WorkflowTemplate</maml:name> <maml:description> <maml:para>Specify the workflow template details to be returned using a workflow template query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ConfigurationItemQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ConfigurationItemQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ConfigurationItemQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemField[]</maml:name> </dev:type> <maml:description> <maml:para>The Configuration item field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemView</maml:name> </dev:type> <maml:description> <maml:para>The configuration item view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemOrderField</maml:name> </dev:type> <maml:description> <maml:para>The configuration item order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemRelationQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item relation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContractQuery</maml:name> </dev:type> <maml:description> <maml:para>A contract query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InvoiceQuery</maml:name> </dev:type> <maml:description> <maml:para>An invoice query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SiteQuery</maml:name> </dev:type> <maml:description> <maml:para>A site query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemQuery</maml:name> </dev:type> <maml:description> <maml:para>A problem query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductQuery</maml:name> </dev:type> <maml:description> <maml:para>A product query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecurrenceQuery</maml:name> </dev:type> <maml:description> <maml:para>A recurrence query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ConfigurationItemQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentConfigurationItemQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentConfigurationItemQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new configuration item query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentConfigurationItemQueryFilter cmdlet creates and configures a configuration item query filter object using the provided parameters. These filters can be used with the New-XurrentConfigurationItemQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentConfigurationItemQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ConfigurationItemFilter</command:parameterValue> <dev:type> <maml:name>ConfigurationItemFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ConfigurationItemFilter</command:parameterValue> <dev:type> <maml:name>ConfigurationItemFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemFilter</maml:name> </dev:type> <maml:description> <maml:para>a configuration item filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ConfigurationItemQuery></maml:name> </dev:type> <maml:description> <maml:para>A configuration item query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentConfigurationItemRelationQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentConfigurationItemRelationQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a configuration item relation query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentConfigurationItemRelationQuery cmdlet creates and configures a configuration item relation query object using the provided parameters. These result can be used with the Invoke-XurrentConfigurationItemRelationQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentConfigurationItemRelationQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a configuration item relation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ConfigurationItemRelationField[]</command:parameterValue> <dev:type> <maml:name>ConfigurationItemRelationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>Specify the configuration item details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a configuration item relation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ConfigurationItemRelationField[]</command:parameterValue> <dev:type> <maml:name>ConfigurationItemRelationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>Specify the configuration item details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemRelationField[]</maml:name> </dev:type> <maml:description> <maml:para>The Configuration item relation field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ConfigurationItemRelationQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item relation query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentContactQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentContactQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a contact query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentContactQuery cmdlet creates and configures a contact query object using the provided parameters. These result can be used with the Invoke-XurrentContactQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentContactQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a contact properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ContactField[]</command:parameterValue> <dev:type> <maml:name>ContactField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a contact properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ContactField[]</command:parameterValue> <dev:type> <maml:name>ContactField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContactField[]</maml:name> </dev:type> <maml:description> <maml:para>The Contact field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ContactQuery</maml:name> </dev:type> <maml:description> <maml:para>A contact query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentContract</command:name> <command:verb>New</command:verb> <command:noun>XurrentContract</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new contract.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a contract using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentContract</maml:name> <command:parameter required="true" position="0"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization that pays for the contract.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the contract.If a unique ID is given to each contract, then this ID can be added at the start of the name.Example:• 2EGXQ2W – Dell 3-Year ProSupport and Next Business Day Onsite Repair for CMP00035</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Category</maml:name> <maml:description> <maml:para>Used to select the appropriate category for the contract.</maml:para> </maml:description> <command:parameterValue required="false">ContractCategory</command:parameterValue> <dev:type> <maml:name>ContractCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the contract.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomerRepresentativeId</maml:name> <maml:description> <maml:para>Identifier of the person who represents the customer of the contract.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ExpiryDate</maml:name> <maml:description> <maml:para>The date through which the contract will be active. The contract expires at the end of this day if it is not renewed before then.When the contract has expired, its status will automatically be set to expired.As long as notice still needs to be given to terminate the contract, the expiryDate field is to remain empty.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>NoticeDate</maml:name> <maml:description> <maml:para>The last day on which the supplier organization can still be contacted to terminate the contract to ensure that it expires on the intended expiry date.The noticeDate field is left empty, and the expiryDate field is filled out, when the contract is to expire on a specific date and no notice needs to be given to terminate it.As long as notice still needs to be given to terminate the contract, the expiryDate field is to remain empty.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the contract that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The first day during which the contract is active.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the contract.</maml:para> </maml:description> <command:parameterValue required="false">AgreementStatus</command:parameterValue> <dev:type> <maml:name>AgreementStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SupplierContactId</maml:name> <maml:description> <maml:para>Identifier of the person who represents the supplier of the contract.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the organization that has provided the contract to the customer.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the start date, notice date and expiry date of the contract.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="20"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of contract properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ContractField[]</command:parameterValue> <dev:type> <maml:name>ContractField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization that pays for the contract.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the contract.If a unique ID is given to each contract, then this ID can be added at the start of the name.Example:• 2EGXQ2W – Dell 3-Year ProSupport and Next Business Day Onsite Repair for CMP00035</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Category</maml:name> <maml:description> <maml:para>Used to select the appropriate category for the contract.</maml:para> </maml:description> <command:parameterValue required="false">ContractCategory</command:parameterValue> <dev:type> <maml:name>ContractCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the contract.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomerRepresentativeId</maml:name> <maml:description> <maml:para>Identifier of the person who represents the customer of the contract.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ExpiryDate</maml:name> <maml:description> <maml:para>The date through which the contract will be active. The contract expires at the end of this day if it is not renewed before then.When the contract has expired, its status will automatically be set to expired.As long as notice still needs to be given to terminate the contract, the expiryDate field is to remain empty.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>NoticeDate</maml:name> <maml:description> <maml:para>The last day on which the supplier organization can still be contacted to terminate the contract to ensure that it expires on the intended expiry date.The noticeDate field is left empty, and the expiryDate field is filled out, when the contract is to expire on a specific date and no notice needs to be given to terminate it.As long as notice still needs to be given to terminate the contract, the expiryDate field is to remain empty.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the contract that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The first day during which the contract is active.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the contract.</maml:para> </maml:description> <command:parameterValue required="false">AgreementStatus</command:parameterValue> <dev:type> <maml:name>AgreementStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SupplierContactId</maml:name> <maml:description> <maml:para>Identifier of the person who represents the supplier of the contract.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the organization that has provided the contract to the customer.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the start date, notice date and expiry date of the contract.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="20"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of contract properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ContractField[]</command:parameterValue> <dev:type> <maml:name>ContractField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContractCategory</maml:name> </dev:type> <maml:description> <maml:para>A contract category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgreementStatus</maml:name> </dev:type> <maml:description> <maml:para>An agreement status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContractField[]</maml:name> </dev:type> <maml:description> <maml:para>The contract field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Contract</maml:name> </dev:type> <maml:description> <maml:para>A contract object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentContractQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentContractQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a contract query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentContractQuery cmdlet creates and configures a contract query object using the provided parameters. These result can be used with the Invoke-XurrentContractQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentContractQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the contract query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a contract properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ContractField[]</command:parameterValue> <dev:type> <maml:name>ContractField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ContractView</command:parameterValue> <dev:type> <maml:name>ContractView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ContractOrderField</command:parameterValue> <dev:type> <maml:name>ContractOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Customer</maml:name> <maml:description> <maml:para>Specify the customer details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomerAccount</maml:name> <maml:description> <maml:para>Specify the customer account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomerRepresentative</maml:name> <maml:description> <maml:para>Specify the customer representative details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Invoices</maml:name> <maml:description> <maml:para>Specify the invoices details to be returned using an invoice query.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SupplierContact</maml:name> <maml:description> <maml:para>Specify the supplier contact details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ContractQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ContractQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ContractQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the contract query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a contract properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ContractField[]</command:parameterValue> <dev:type> <maml:name>ContractField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ContractView</command:parameterValue> <dev:type> <maml:name>ContractView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ContractOrderField</command:parameterValue> <dev:type> <maml:name>ContractOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Customer</maml:name> <maml:description> <maml:para>Specify the customer details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomerAccount</maml:name> <maml:description> <maml:para>Specify the customer account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomerRepresentative</maml:name> <maml:description> <maml:para>Specify the customer representative details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Invoices</maml:name> <maml:description> <maml:para>Specify the invoices details to be returned using an invoice query.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SupplierContact</maml:name> <maml:description> <maml:para>Specify the supplier contact details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ContractQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ContractQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ContractQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContractField[]</maml:name> </dev:type> <maml:description> <maml:para>The Contract field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContractView</maml:name> </dev:type> <maml:description> <maml:para>The contract view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContractOrderField</maml:name> </dev:type> <maml:description> <maml:para>The contract order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InvoiceQuery</maml:name> </dev:type> <maml:description> <maml:para>An invoice query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ContractQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A contract query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ContractQuery</maml:name> </dev:type> <maml:description> <maml:para>A contract query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentContractQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentContractQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new contract query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentContractQueryFilter cmdlet creates and configures a contract query filter object using the provided parameters. These filters can be used with the New-XurrentContractQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentContractQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ContractFilter</command:parameterValue> <dev:type> <maml:name>ContractFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ContractFilter</command:parameterValue> <dev:type> <maml:name>ContractFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContractFilter</maml:name> </dev:type> <maml:description> <maml:para>a contract filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ContractQuery></maml:name> </dev:type> <maml:description> <maml:para>A contract query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentCustomCollection</command:name> <command:verb>New</command:verb> <command:noun>XurrentCustomCollection</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new custom collection.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a custom collection using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentCustomCollection</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the collection.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the collection.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the collection may not be used for new custom views.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>NewCollectionElements</maml:name> <maml:description> <maml:para>Elements of this custom collection.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionElementInput[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Reference</maml:name> <maml:description> <maml:para>The Reference field defaults to the Name field value, written in lower case characters and with all spaces replaced by the underscore character. This reference can be used to link the collection to an element using the Xurrent APIs or the Xurrent Import functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of custom collection properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomCollectionField[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the collection.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the collection.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the collection may not be used for new custom views.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>NewCollectionElements</maml:name> <maml:description> <maml:para>Elements of this custom collection.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionElementInput[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Reference</maml:name> <maml:description> <maml:para>The Reference field defaults to the Name field value, written in lower case characters and with all spaces replaced by the underscore character. This reference can be used to link the collection to an element using the Xurrent APIs or the Xurrent Import functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of custom collection properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomCollectionField[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionElementInput[]</maml:name> </dev:type> <maml:description> <maml:para>A custom collection element input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionField[]</maml:name> </dev:type> <maml:description> <maml:para>The custom collection field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom collection object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentCustomCollectionElement</command:name> <command:verb>New</command:verb> <command:noun>XurrentCustomCollectionElement</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new custom collection element.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a custom collection element using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentCustomCollectionElement</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the collection element.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomCollection</maml:name> <maml:description> <maml:para>Reference of the collection of this element.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomCollectionId</maml:name> <maml:description> <maml:para>Identifier of the collection of this element.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the collection element.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the collection element may not be referenced from custom fields of other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the element that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Reference</maml:name> <maml:description> <maml:para>The Reference field defaults to the Name field value, written in lower case characters and with all spaces replaced by the underscore character.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of custom collection element properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomCollectionElementField[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the collection element.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomCollection</maml:name> <maml:description> <maml:para>Reference of the collection of this element.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomCollectionId</maml:name> <maml:description> <maml:para>Identifier of the collection of this element.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the collection element.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the collection element may not be referenced from custom fields of other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the element that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Reference</maml:name> <maml:description> <maml:para>The Reference field defaults to the Name field value, written in lower case characters and with all spaces replaced by the underscore character.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of custom collection element properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomCollectionElementField[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionElementField[]</maml:name> </dev:type> <maml:description> <maml:para>The custom collection element field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomCollectionElement</maml:name> </dev:type> <maml:description> <maml:para>A custom collection element object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentCustomCollectionElementQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentCustomCollectionElementQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a custom collection element query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentCustomCollectionElementQuery cmdlet creates and configures a custom collection element query object using the provided parameters. These result can be used with the Invoke-XurrentCustomCollectionElementQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentCustomCollectionElementQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the custom collection element query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a custom collection element properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomCollectionElementField[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionElementView</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionElementOrderField</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomCollection</maml:name> <maml:description> <maml:para>Specify the custom collection details to be returned using a custom collection query.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionQuery</command:parameterValue> <dev:type> <maml:name>CustomCollectionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<CustomCollectionElementQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<CustomCollectionElementQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<CustomCollectionElementQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the custom collection element query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a custom collection element properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomCollectionElementField[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionElementView</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionElementOrderField</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomCollection</maml:name> <maml:description> <maml:para>Specify the custom collection details to be returned using a custom collection query.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionQuery</command:parameterValue> <dev:type> <maml:name>CustomCollectionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<CustomCollectionElementQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<CustomCollectionElementQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<CustomCollectionElementQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionElementField[]</maml:name> </dev:type> <maml:description> <maml:para>The Custom collection element field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionElementView</maml:name> </dev:type> <maml:description> <maml:para>The custom collection element view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionElementOrderField</maml:name> </dev:type> <maml:description> <maml:para>The custom collection element order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom collection query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<CustomCollectionElementQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A custom collection element query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomCollectionElementQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom collection element query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentCustomCollectionElementQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentCustomCollectionElementQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new custom collection element query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentCustomCollectionElementQueryFilter cmdlet creates and configures a custom collection element query filter object using the provided parameters. These filters can be used with the New-XurrentCustomCollectionElementQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentCustomCollectionElementQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">CustomCollectionElementFilter</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">CustomCollectionElementFilter</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionElementFilter</maml:name> </dev:type> <maml:description> <maml:para>a custom collection element filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<CustomCollectionElementQuery></maml:name> </dev:type> <maml:description> <maml:para>A custom collection element query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentCustomCollectionQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentCustomCollectionQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a custom collection query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentCustomCollectionQuery cmdlet creates and configures a custom collection query object using the provided parameters. These result can be used with the Invoke-XurrentCustomCollectionQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentCustomCollectionQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the custom collection query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a custom collection properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomCollectionField[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CollectionElements</maml:name> <maml:description> <maml:para>Specify the collection elements details to be returned using a custom collection element query.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionElementQuery</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<CustomCollectionQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<CustomCollectionQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<CustomCollectionQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the custom collection query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a custom collection properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomCollectionField[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CollectionElements</maml:name> <maml:description> <maml:para>Specify the collection elements details to be returned using a custom collection element query.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionElementQuery</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<CustomCollectionQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<CustomCollectionQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<CustomCollectionQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionField[]</maml:name> </dev:type> <maml:description> <maml:para>The Custom collection field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionElementQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom collection element query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<CustomCollectionQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A custom collection query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomCollectionQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom collection query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentCustomCollectionQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentCustomCollectionQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new custom collection query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentCustomCollectionQueryFilter cmdlet creates and configures a custom collection query filter object using the provided parameters. These filters can be used with the New-XurrentCustomCollectionQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentCustomCollectionQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">CustomCollectionFilter</command:parameterValue> <dev:type> <maml:name>CustomCollectionFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">CustomCollectionFilter</command:parameterValue> <dev:type> <maml:name>CustomCollectionFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionFilter</maml:name> </dev:type> <maml:description> <maml:para>a custom collection filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<CustomCollectionQuery></maml:name> </dev:type> <maml:description> <maml:para>A custom collection query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentCustomFieldCollection</command:name> <command:verb>New</command:verb> <command:noun>XurrentCustomFieldCollection</command:noun> <command:description> <maml:para>A PowerShell cmdlet to create a new CustomFieldCollection.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentCustomFieldCollection creates a new Custom Field Collection.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentCustomFieldCollection</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>The newly created Custom Field Collection.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentCustomFieldQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentCustomFieldQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a custom field query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentCustomFieldQuery cmdlet creates and configures a custom field query object using the provided parameters. These result can be used with the Invoke-XurrentCustomFieldQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentCustomFieldQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a custom field properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomFieldField[]</command:parameterValue> <dev:type> <maml:name>CustomFieldField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a custom field properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomFieldField[]</command:parameterValue> <dev:type> <maml:name>CustomFieldField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldField[]</maml:name> </dev:type> <maml:description> <maml:para>The Custom field field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentCustomFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentCustomFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new Xurrent custom filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentCustomFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the filter.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator for the filter.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Values</maml:name> <maml:description> <maml:para>The values for the filter.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the filter.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator for the filter.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Values</maml:name> <maml:description> <maml:para>The values for the filter.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent filter operator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.CustomFilter</maml:name> </dev:type> <maml:description> <maml:para>The created custom filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentEffortClass</command:name> <command:verb>New</command:verb> <command:noun>XurrentEffortClass</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new effort class.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates an effort class using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentEffortClass</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the effort class.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CostMultiplier</maml:name> <maml:description> <maml:para>The amount with which to multiply the cost of time entries with this effort class.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the effort class may no longer be related to any more timesheet settings.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the effort class takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServiceOfferingIds</maml:name> <maml:description> <maml:para>IDs of the service offerings of this effort class.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>IDs of the skill pools of this effort class.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>TimesheetSettingIds</maml:name> <maml:description> <maml:para>IDs of the timesheet settings of this effort class.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of effort class properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EffortClassField[]</command:parameterValue> <dev:type> <maml:name>EffortClassField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the effort class.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CostMultiplier</maml:name> <maml:description> <maml:para>The amount with which to multiply the cost of time entries with this effort class.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the effort class may no longer be related to any more timesheet settings.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the effort class takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServiceOfferingIds</maml:name> <maml:description> <maml:para>IDs of the service offerings of this effort class.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>IDs of the skill pools of this effort class.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>TimesheetSettingIds</maml:name> <maml:description> <maml:para>IDs of the timesheet settings of this effort class.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of effort class properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EffortClassField[]</command:parameterValue> <dev:type> <maml:name>EffortClassField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassField[]</maml:name> </dev:type> <maml:description> <maml:para>The effort class field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>EffortClass</maml:name> </dev:type> <maml:description> <maml:para>An effort class object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentEffortClassQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentEffortClassQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an effort class query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentEffortClassQuery cmdlet creates and configures an effort class query object using the provided parameters. These result can be used with the Invoke-XurrentEffortClassQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentEffortClassQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the effort class query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an effort class properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EffortClassField[]</command:parameterValue> <dev:type> <maml:name>EffortClassField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ServiceOfferings</maml:name> <maml:description> <maml:para>Specify the service offerings details to be returned using a service offering query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingQuery</command:parameterValue> <dev:type> <maml:name>ServiceOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SkillPools</maml:name> <maml:description> <maml:para>Specify the skill pools details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>TimesheetSettings</maml:name> <maml:description> <maml:para>Specify the timesheet settings details to be returned using a timesheet setting query.</maml:para> </maml:description> <command:parameterValue required="false">TimesheetSettingQuery</command:parameterValue> <dev:type> <maml:name>TimesheetSettingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<EffortClassQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<EffortClassQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<EffortClassQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the effort class query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an effort class properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EffortClassField[]</command:parameterValue> <dev:type> <maml:name>EffortClassField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ServiceOfferings</maml:name> <maml:description> <maml:para>Specify the service offerings details to be returned using a service offering query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingQuery</command:parameterValue> <dev:type> <maml:name>ServiceOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SkillPools</maml:name> <maml:description> <maml:para>Specify the skill pools details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>TimesheetSettings</maml:name> <maml:description> <maml:para>Specify the timesheet settings details to be returned using a timesheet setting query.</maml:para> </maml:description> <command:parameterValue required="false">TimesheetSettingQuery</command:parameterValue> <dev:type> <maml:name>TimesheetSettingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<EffortClassQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<EffortClassQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<EffortClassQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassField[]</maml:name> </dev:type> <maml:description> <maml:para>The Effort class field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>A service offering query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolQuery</maml:name> </dev:type> <maml:description> <maml:para>A skill pool query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimesheetSettingQuery</maml:name> </dev:type> <maml:description> <maml:para>A timesheet setting query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<EffortClassQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>An effort class query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentEffortClassQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentEffortClassQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new effort class query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentEffortClassQueryFilter cmdlet creates and configures an effort class query filter object using the provided parameters. These filters can be used with the New-XurrentEffortClassQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentEffortClassQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">EffortClassFilter</command:parameterValue> <dev:type> <maml:name>EffortClassFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">EffortClassFilter</command:parameterValue> <dev:type> <maml:name>EffortClassFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassFilter</maml:name> </dev:type> <maml:description> <maml:para>an effort class filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<EffortClassQuery></maml:name> </dev:type> <maml:description> <maml:para>An effort class query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentEffortClassRateIDQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentEffortClassRateIDQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an effort class rate identifier query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentEffortClassRateIDQuery cmdlet creates and configures an effort class rate identifier query object using the provided parameters. These result can be used with the Invoke-XurrentEffortClassRateIDQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentEffortClassRateIDQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an effort class rate identifier properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EffortClassRateIDField[]</command:parameterValue> <dev:type> <maml:name>EffortClassRateIDField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an effort class rate identifier properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EffortClassRateIDField[]</command:parameterValue> <dev:type> <maml:name>EffortClassRateIDField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassRateIDField[]</maml:name> </dev:type> <maml:description> <maml:para>The Effort class rate ID field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>EffortClassRateIDQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class rate identifier query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentEffortClassRateQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentEffortClassRateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an effort class rate query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentEffortClassRateQuery cmdlet creates and configures an effort class rate query object using the provided parameters. These result can be used with the Invoke-XurrentEffortClassRateQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentEffortClassRateQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an effort class rate properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EffortClassRateField[]</command:parameterValue> <dev:type> <maml:name>EffortClassRateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServiceOffering</maml:name> <maml:description> <maml:para>Specify the service offering details to be returned using a service offering query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingQuery</command:parameterValue> <dev:type> <maml:name>ServiceOfferingQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an effort class rate properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EffortClassRateField[]</command:parameterValue> <dev:type> <maml:name>EffortClassRateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServiceOffering</maml:name> <maml:description> <maml:para>Specify the service offering details to be returned using a service offering query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingQuery</command:parameterValue> <dev:type> <maml:name>ServiceOfferingQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassRateField[]</maml:name> </dev:type> <maml:description> <maml:para>The Effort class rate field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>A service offering query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>EffortClassRateQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class rate query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentEmailTemplateQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentEmailTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an email template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentEmailTemplateQuery cmdlet creates and configures an email template query object using the provided parameters. These result can be used with the Invoke-XurrentEmailTemplateQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentEmailTemplateQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an email template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EmailTemplateField[]</command:parameterValue> <dev:type> <maml:name>EmailTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an email template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EmailTemplateField[]</command:parameterValue> <dev:type> <maml:name>EmailTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EmailTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The Email template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>EmailTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>An email template query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentEvent</command:name> <command:verb>New</command:verb> <command:noun>XurrentEvent</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new Xurrent event request.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentEvent</maml:name> <command:parameter required="false" position="0"> <maml:name>Category</maml:name> <maml:description> <maml:para>Used to specify an option in the Category field of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestCategory</command:parameterValue> <dev:type> <maml:name>RequestCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ConfigurationItemName</maml:name> <maml:description> <maml:para>The configuration item identified by its label or name.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ConfigurationItemID</maml:name> <maml:description> <maml:para>The configuration item identified by its ID.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ConfigurationItemSource</maml:name> <maml:description> <maml:para>The configuration item identified by its source and sourceID.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationItemSourceID</maml:name> <maml:description> <maml:para>The configuration item identified by its source and sourceID.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>The configuration item identified by its ID, or by its source and sourceID when the ID is null or empty.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>ConfigurationItem</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>Used to specify an option in the completion reason field when the status is set to completed.</maml:para> </maml:description> <command:parameterValue required="false">RequestCompletionReason</command:parameterValue> <dev:type> <maml:name>RequestCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DesiredCompletionAt</maml:name> <maml:description> <maml:para>The agreed date and time for the completion of the request.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DownTimeEndAt</maml:name> <maml:description> <maml:para>The end date and time of a service outage.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DownTimeStartAt</maml:name> <maml:description> <maml:para>The start date and time of a service outage.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Impact</maml:name> <maml:description> <maml:para>Used to specify an option in the impact field of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestImpact</command:parameterValue> <dev:type> <maml:name>RequestImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>InternalNote</maml:name> <maml:description> <maml:para>The text to be added as an internal note to the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>MemberPrimaryEmail</maml:name> <maml:description> <maml:para>The person to which the request is to be assigned, identified by primary email.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>MemberID</maml:name> <maml:description> <maml:para>The person to which the request is to be assigned, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Member</maml:name> <maml:description> <maml:para>The person to which the request is to be assigned, identified by ID or primary email.</maml:para> </maml:description> <command:parameterValue required="false">Person</command:parameterValue> <dev:type> <maml:name>Person</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Note</maml:name> <maml:description> <maml:para>The text to be added as a note to the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProblemID</maml:name> <maml:description> <maml:para>The problem to be related to the request, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Problem</maml:name> <maml:description> <maml:para>The problem to be related to the request, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Problem</command:parameterValue> <dev:type> <maml:name>Problem</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RequestedByPrimaryEmailAddress</maml:name> <maml:description> <maml:para>The person who is to be selected in the requested by field, identified by primary email.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>RequestedByID</maml:name> <maml:description> <maml:para>The person who is to be selected in the requested by field, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>RequestedBy</maml:name> <maml:description> <maml:para>The person who is to be selected in the requested by field, identified by ID or primary email.</maml:para> </maml:description> <command:parameterValue required="false">Person</command:parameterValue> <dev:type> <maml:name>Person</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>RequestedForPrimaryEmailAddress</maml:name> <maml:description> <maml:para>The person who is to be selected in the requested for field, identified by primary email.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>RequestedForID</maml:name> <maml:description> <maml:para>The person who is to be selected in the requested for field, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>RequestedFor</maml:name> <maml:description> <maml:para>The person who is to be selected in the requested for field, identified by ID or primary email.</maml:para> </maml:description> <command:parameterValue required="false">Person</command:parameterValue> <dev:type> <maml:name>Person</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>ServiceInstanceName</maml:name> <maml:description> <maml:para>The service instance to be related to the request, identified by name.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>ServiceInstanceID</maml:name> <maml:description> <maml:para>The service instance to be related to the request, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>The service instance to be related to the request.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstance</command:parameterValue> <dev:type> <maml:name>ServiceInstance</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Source</maml:name> <maml:description> <maml:para>The name of the monitoring tool.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique ID of the event for which the request is to be registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Status</maml:name> <maml:description> <maml:para>An option in the status field of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestStatus</command:parameterValue> <dev:type> <maml:name>RequestStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>Subject</maml:name> <maml:description> <maml:para>The subject of the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>SupplierName</maml:name> <maml:description> <maml:para>The organization to which the request has been submitted, identified by name.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SupplierID</maml:name> <maml:description> <maml:para>The organization to which the request has been submitted, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>The organization to which the request has been submitted, identified by ID or name.</maml:para> </maml:description> <command:parameterValue required="false">Organization</command:parameterValue> <dev:type> <maml:name>Organization</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SupportDomainAccountID</maml:name> <maml:description> <maml:para>The support domain account ID for the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>SupportDomain</maml:name> <maml:description> <maml:para>The support domain account for the request.</maml:para> </maml:description> <command:parameterValue required="false">Account</command:parameterValue> <dev:type> <maml:name>Account</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>TeamName</maml:name> <maml:description> <maml:para>The team to which the request is to be assigned, identified by name.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>TeamID</maml:name> <maml:description> <maml:para>The team to which the request is to be assigned, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Team</maml:name> <maml:description> <maml:para>The team to which the request is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">Team</command:parameterValue> <dev:type> <maml:name>Team</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>RequestTemplateID</maml:name> <maml:description> <maml:para>The request template to be applied to the request, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>RequestTemplate</maml:name> <maml:description> <maml:para>The request template to be applied to the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplate</command:parameterValue> <dev:type> <maml:name>RequestTemplate</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time to update the status from waiting_for to assigned.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>WorkflowID</maml:name> <maml:description> <maml:para>The workflow related to the request, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>The workflow related to the request.</maml:para> </maml:description> <command:parameterValue required="false">Workflow</command:parameterValue> <dev:type> <maml:name>Workflow</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to upload the file. If not provided, the default client is used.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>Category</maml:name> <maml:description> <maml:para>Used to specify an option in the Category field of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestCategory</command:parameterValue> <dev:type> <maml:name>RequestCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ConfigurationItemName</maml:name> <maml:description> <maml:para>The configuration item identified by its label or name.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ConfigurationItemID</maml:name> <maml:description> <maml:para>The configuration item identified by its ID.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ConfigurationItemSource</maml:name> <maml:description> <maml:para>The configuration item identified by its source and sourceID.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationItemSourceID</maml:name> <maml:description> <maml:para>The configuration item identified by its source and sourceID.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>The configuration item identified by its ID, or by its source and sourceID when the ID is null or empty.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>ConfigurationItem</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>Used to specify an option in the completion reason field when the status is set to completed.</maml:para> </maml:description> <command:parameterValue required="false">RequestCompletionReason</command:parameterValue> <dev:type> <maml:name>RequestCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DesiredCompletionAt</maml:name> <maml:description> <maml:para>The agreed date and time for the completion of the request.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DownTimeEndAt</maml:name> <maml:description> <maml:para>The end date and time of a service outage.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DownTimeStartAt</maml:name> <maml:description> <maml:para>The start date and time of a service outage.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Impact</maml:name> <maml:description> <maml:para>Used to specify an option in the impact field of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestImpact</command:parameterValue> <dev:type> <maml:name>RequestImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>InternalNote</maml:name> <maml:description> <maml:para>The text to be added as an internal note to the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>MemberPrimaryEmail</maml:name> <maml:description> <maml:para>The person to which the request is to be assigned, identified by primary email.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>MemberID</maml:name> <maml:description> <maml:para>The person to which the request is to be assigned, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Member</maml:name> <maml:description> <maml:para>The person to which the request is to be assigned, identified by ID or primary email.</maml:para> </maml:description> <command:parameterValue required="false">Person</command:parameterValue> <dev:type> <maml:name>Person</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Note</maml:name> <maml:description> <maml:para>The text to be added as a note to the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProblemID</maml:name> <maml:description> <maml:para>The problem to be related to the request, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Problem</maml:name> <maml:description> <maml:para>The problem to be related to the request, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Problem</command:parameterValue> <dev:type> <maml:name>Problem</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RequestedByPrimaryEmailAddress</maml:name> <maml:description> <maml:para>The person who is to be selected in the requested by field, identified by primary email.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>RequestedByID</maml:name> <maml:description> <maml:para>The person who is to be selected in the requested by field, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>RequestedBy</maml:name> <maml:description> <maml:para>The person who is to be selected in the requested by field, identified by ID or primary email.</maml:para> </maml:description> <command:parameterValue required="false">Person</command:parameterValue> <dev:type> <maml:name>Person</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>RequestedForPrimaryEmailAddress</maml:name> <maml:description> <maml:para>The person who is to be selected in the requested for field, identified by primary email.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>RequestedForID</maml:name> <maml:description> <maml:para>The person who is to be selected in the requested for field, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>RequestedFor</maml:name> <maml:description> <maml:para>The person who is to be selected in the requested for field, identified by ID or primary email.</maml:para> </maml:description> <command:parameterValue required="false">Person</command:parameterValue> <dev:type> <maml:name>Person</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>ServiceInstanceName</maml:name> <maml:description> <maml:para>The service instance to be related to the request, identified by name.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>ServiceInstanceID</maml:name> <maml:description> <maml:para>The service instance to be related to the request, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>The service instance to be related to the request.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstance</command:parameterValue> <dev:type> <maml:name>ServiceInstance</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Source</maml:name> <maml:description> <maml:para>The name of the monitoring tool.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique ID of the event for which the request is to be registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Status</maml:name> <maml:description> <maml:para>An option in the status field of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestStatus</command:parameterValue> <dev:type> <maml:name>RequestStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>Subject</maml:name> <maml:description> <maml:para>The subject of the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>SupplierName</maml:name> <maml:description> <maml:para>The organization to which the request has been submitted, identified by name.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SupplierID</maml:name> <maml:description> <maml:para>The organization to which the request has been submitted, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>The organization to which the request has been submitted, identified by ID or name.</maml:para> </maml:description> <command:parameterValue required="false">Organization</command:parameterValue> <dev:type> <maml:name>Organization</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SupportDomainAccountID</maml:name> <maml:description> <maml:para>The support domain account ID for the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>SupportDomain</maml:name> <maml:description> <maml:para>The support domain account for the request.</maml:para> </maml:description> <command:parameterValue required="false">Account</command:parameterValue> <dev:type> <maml:name>Account</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>TeamName</maml:name> <maml:description> <maml:para>The team to which the request is to be assigned, identified by name.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>TeamID</maml:name> <maml:description> <maml:para>The team to which the request is to be assigned, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Team</maml:name> <maml:description> <maml:para>The team to which the request is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">Team</command:parameterValue> <dev:type> <maml:name>Team</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>RequestTemplateID</maml:name> <maml:description> <maml:para>The request template to be applied to the request, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>RequestTemplate</maml:name> <maml:description> <maml:para>The request template to be applied to the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplate</command:parameterValue> <dev:type> <maml:name>RequestTemplate</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time to update the status from waiting_for to assigned.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>WorkflowID</maml:name> <maml:description> <maml:para>The workflow related to the request, identified by ID.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>The workflow related to the request.</maml:para> </maml:description> <command:parameterValue required="false">Workflow</command:parameterValue> <dev:type> <maml:name>Workflow</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to upload the file. If not provided, the default client is used.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.Account</maml:name> </dev:type> <maml:description> <maml:para>An Xurrent account object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItem</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent configuration item object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.Organization</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent organization object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.Person</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent person object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.Problem</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent problem object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestCategory</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent request category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestImpact</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent request impact object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestStatus</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent request status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplate</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent request template object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstance</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent service instance object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.Team</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent team object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.Workflow</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent workflow object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestCompletionReason</maml:name> </dev:type> <maml:description> <maml:para>A Xurrent request completion reason object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Xurrent.GraphQL.Request</maml:name> </dev:type> <maml:description> <maml:para>The created event request.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentFeedbackQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentFeedbackQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a feedback query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentFeedbackQuery cmdlet creates and configures a feedback query object using the provided parameters. These result can be used with the Invoke-XurrentFeedbackQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentFeedbackQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a feedback properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FeedbackField[]</command:parameterValue> <dev:type> <maml:name>FeedbackField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>RequestedBy</maml:name> <maml:description> <maml:para>Specify the requested by details to be returned using a feedback uniform resource locators query.</maml:para> </maml:description> <command:parameterValue required="false">FeedbackUrlsQuery</command:parameterValue> <dev:type> <maml:name>FeedbackUrlsQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>RequestedFor</maml:name> <maml:description> <maml:para>Specify the requested for details to be returned using a feedback uniform resource locators query.</maml:para> </maml:description> <command:parameterValue required="false">FeedbackUrlsQuery</command:parameterValue> <dev:type> <maml:name>FeedbackUrlsQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a feedback properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FeedbackField[]</command:parameterValue> <dev:type> <maml:name>FeedbackField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>RequestedBy</maml:name> <maml:description> <maml:para>Specify the requested by details to be returned using a feedback uniform resource locators query.</maml:para> </maml:description> <command:parameterValue required="false">FeedbackUrlsQuery</command:parameterValue> <dev:type> <maml:name>FeedbackUrlsQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>RequestedFor</maml:name> <maml:description> <maml:para>Specify the requested for details to be returned using a feedback uniform resource locators query.</maml:para> </maml:description> <command:parameterValue required="false">FeedbackUrlsQuery</command:parameterValue> <dev:type> <maml:name>FeedbackUrlsQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FeedbackField[]</maml:name> </dev:type> <maml:description> <maml:para>The Feedback field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FeedbackUrlsQuery</maml:name> </dev:type> <maml:description> <maml:para>A feedback uniform resource locators query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>FeedbackQuery</maml:name> </dev:type> <maml:description> <maml:para>A feedback query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentFeedbackUrlsQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentFeedbackUrlsQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a feedback uniform resource locators query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentFeedbackUrlsQuery cmdlet creates and configures a feedback uniform resource locators query object using the provided parameters. These result can be used with the Invoke-XurrentFeedbackUrlsQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentFeedbackUrlsQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a feedback uniform resource locators properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FeedbackUrlsField[]</command:parameterValue> <dev:type> <maml:name>FeedbackUrlsField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a feedback uniform resource locators properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FeedbackUrlsField[]</command:parameterValue> <dev:type> <maml:name>FeedbackUrlsField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FeedbackUrlsField[]</maml:name> </dev:type> <maml:description> <maml:para>The Feedback URLs field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>FeedbackUrlsQuery</maml:name> </dev:type> <maml:description> <maml:para>A feedback uniform resource locators query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentFirstLineSupportAgreement</command:name> <command:verb>New</command:verb> <command:noun>XurrentFirstLineSupportAgreement</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new first line support agreement.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a first line support agreement using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentFirstLineSupportAgreement</maml:name> <command:parameter required="true" position="0"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization that pays for the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ProviderId</maml:name> <maml:description> <maml:para>Identifier of the organization that provides the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Charges</maml:name> <maml:description> <maml:para>The amounts that the customer will be charged for the first line support agreement. These can be recurring as well as one-off charges.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomerRepresentativeId</maml:name> <maml:description> <maml:para>Identifier of the customer representative.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ExpiryDate</maml:name> <maml:description> <maml:para>The date through which the first line support agreement (FLSA) will be active. The FLSA expires at the end of this day if it is not renewed before then. When the FLSA has expired, its status will automatically be set to "Expired".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>FirstCallResolutions</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be completed by the service desk team during their registration.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>NoticeDate</maml:name> <maml:description> <maml:para>The last day on which the first line support provider organization can still be contacted to terminate the first line support agreement (FLSA) to ensure that it expires on the intended expiry date. The Notice date field is left empty, and the Expiry date field is filled out, when the FLSA is to expire on a specific date and no notice needs to be given to terminate it.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>PickupsWithinTarget</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be picked up by the service desk team within the pickup target.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PickupTarget</maml:name> <maml:description> <maml:para>The number of minutes within which a new or existing request that has been assigned to the service desk team is assigned to a specific member within the service desk team, is assigned to another team, or is set to a status other than assigned.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RejectedSolutions</maml:name> <maml:description> <maml:para>The maximum percentage of requests that were reopened (i.e. which status in the account that is covered by the first line support agreement was updated from completed to another status).</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the first line support agreement that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ServiceDeskOnlyResolutions</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be completed by the service desk team without having been assigned to any other team within the account that is covered by the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ServiceDeskResolutions</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be completed by the service desk team.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ServiceDeskTeamId</maml:name> <maml:description> <maml:para>Identifier of the specific team within the first line support provider organization that provides first line support for the users covered by the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The first day during which the first line support agreement (FLSA) is active.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the first line support agreement (FLSA).</maml:para> </maml:description> <command:parameterValue required="false">AgreementStatus</command:parameterValue> <dev:type> <maml:name>AgreementStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SupportChatPickupTarget</maml:name> <maml:description> <maml:para>The number of minutes within which a new or existing chat request that has been assigned to the service desk team is assigned to a specific member within the service desk team, is assigned to another team, or is set to a status other than assigned.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SupportHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours during which the service desk team can be contacted for first line support.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>TargetDetails</maml:name> <maml:description> <maml:para>A description of all the targets of the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the start, notice and expiry dates, and to the support hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="25"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of first line support agreement properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FirstLineSupportAgreementField[]</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization that pays for the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ProviderId</maml:name> <maml:description> <maml:para>Identifier of the organization that provides the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Charges</maml:name> <maml:description> <maml:para>The amounts that the customer will be charged for the first line support agreement. These can be recurring as well as one-off charges.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomerRepresentativeId</maml:name> <maml:description> <maml:para>Identifier of the customer representative.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ExpiryDate</maml:name> <maml:description> <maml:para>The date through which the first line support agreement (FLSA) will be active. The FLSA expires at the end of this day if it is not renewed before then. When the FLSA has expired, its status will automatically be set to "Expired".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>FirstCallResolutions</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be completed by the service desk team during their registration.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>NoticeDate</maml:name> <maml:description> <maml:para>The last day on which the first line support provider organization can still be contacted to terminate the first line support agreement (FLSA) to ensure that it expires on the intended expiry date. The Notice date field is left empty, and the Expiry date field is filled out, when the FLSA is to expire on a specific date and no notice needs to be given to terminate it.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>PickupsWithinTarget</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be picked up by the service desk team within the pickup target.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PickupTarget</maml:name> <maml:description> <maml:para>The number of minutes within which a new or existing request that has been assigned to the service desk team is assigned to a specific member within the service desk team, is assigned to another team, or is set to a status other than assigned.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RejectedSolutions</maml:name> <maml:description> <maml:para>The maximum percentage of requests that were reopened (i.e. which status in the account that is covered by the first line support agreement was updated from completed to another status).</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the first line support agreement that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ServiceDeskOnlyResolutions</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be completed by the service desk team without having been assigned to any other team within the account that is covered by the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ServiceDeskResolutions</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be completed by the service desk team.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ServiceDeskTeamId</maml:name> <maml:description> <maml:para>Identifier of the specific team within the first line support provider organization that provides first line support for the users covered by the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The first day during which the first line support agreement (FLSA) is active.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the first line support agreement (FLSA).</maml:para> </maml:description> <command:parameterValue required="false">AgreementStatus</command:parameterValue> <dev:type> <maml:name>AgreementStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SupportChatPickupTarget</maml:name> <maml:description> <maml:para>The number of minutes within which a new or existing chat request that has been assigned to the service desk team is assigned to a specific member within the service desk team, is assigned to another team, or is set to a status other than assigned.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SupportHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours during which the service desk team can be contacted for first line support.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>TargetDetails</maml:name> <maml:description> <maml:para>A description of all the targets of the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the start, notice and expiry dates, and to the support hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="25"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of first line support agreement properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FirstLineSupportAgreementField[]</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgreementStatus</maml:name> </dev:type> <maml:description> <maml:para>An agreement status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FirstLineSupportAgreementField[]</maml:name> </dev:type> <maml:description> <maml:para>The first line support agreement field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>FirstLineSupportAgreement</maml:name> </dev:type> <maml:description> <maml:para>A first line support agreement object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentFirstLineSupportAgreementQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentFirstLineSupportAgreementQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a first line support agreement query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentFirstLineSupportAgreementQuery cmdlet creates and configures a first line support agreement query object using the provided parameters. These result can be used with the Invoke-XurrentFirstLineSupportAgreementQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentFirstLineSupportAgreementQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the first line support agreement query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a first line support agreement properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FirstLineSupportAgreementField[]</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">FirstLineSupportAgreementView</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">FirstLineSupportAgreementOrderField</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ChargesAttachments</maml:name> <maml:description> <maml:para>Specify the charges attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Customer</maml:name> <maml:description> <maml:para>Specify the customer details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomerAccount</maml:name> <maml:description> <maml:para>Specify the customer account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomerRepresentative</maml:name> <maml:description> <maml:para>Specify the customer representative details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Invoices</maml:name> <maml:description> <maml:para>Specify the invoices details to be returned using an invoice query.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>MajorIncidentManagers</maml:name> <maml:description> <maml:para>Specify the major incident managers details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Provider</maml:name> <maml:description> <maml:para>Specify the provider details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ServiceDeskTeam</maml:name> <maml:description> <maml:para>Specify the service desk team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SupportHours</maml:name> <maml:description> <maml:para>Specify the support hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>TargetDetailsAttachments</maml:name> <maml:description> <maml:para>Specify the target details attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<FirstLineSupportAgreementQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<FirstLineSupportAgreementQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<FirstLineSupportAgreementQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the first line support agreement query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a first line support agreement properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FirstLineSupportAgreementField[]</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">FirstLineSupportAgreementView</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">FirstLineSupportAgreementOrderField</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ChargesAttachments</maml:name> <maml:description> <maml:para>Specify the charges attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Customer</maml:name> <maml:description> <maml:para>Specify the customer details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomerAccount</maml:name> <maml:description> <maml:para>Specify the customer account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomerRepresentative</maml:name> <maml:description> <maml:para>Specify the customer representative details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Invoices</maml:name> <maml:description> <maml:para>Specify the invoices details to be returned using an invoice query.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>MajorIncidentManagers</maml:name> <maml:description> <maml:para>Specify the major incident managers details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Provider</maml:name> <maml:description> <maml:para>Specify the provider details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ServiceDeskTeam</maml:name> <maml:description> <maml:para>Specify the service desk team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SupportHours</maml:name> <maml:description> <maml:para>Specify the support hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>TargetDetailsAttachments</maml:name> <maml:description> <maml:para>Specify the target details attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<FirstLineSupportAgreementQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<FirstLineSupportAgreementQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<FirstLineSupportAgreementQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FirstLineSupportAgreementField[]</maml:name> </dev:type> <maml:description> <maml:para>The First line support agreement field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FirstLineSupportAgreementView</maml:name> </dev:type> <maml:description> <maml:para>The first line support agreement view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FirstLineSupportAgreementOrderField</maml:name> </dev:type> <maml:description> <maml:para>The first line support agreement order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InvoiceQuery</maml:name> </dev:type> <maml:description> <maml:para>An invoice query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<FirstLineSupportAgreementQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A first line support agreement query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>FirstLineSupportAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A first line support agreement query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentFirstLineSupportAgreementQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentFirstLineSupportAgreementQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new first line support agreement query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentFirstLineSupportAgreementQueryFilter cmdlet creates and configures a first line support agreement query filter object using the provided parameters. These filters can be used with the New-XurrentFirstLineSupportAgreementQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentFirstLineSupportAgreementQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FirstLineSupportAgreementFilter</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FirstLineSupportAgreementFilter</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FirstLineSupportAgreementFilter</maml:name> </dev:type> <maml:description> <maml:para>a first line support agreement filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<FirstLineSupportAgreementQuery></maml:name> </dev:type> <maml:description> <maml:para>A first line support agreement query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentHoliday</command:name> <command:verb>New</command:verb> <command:noun>XurrentHoliday</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new holiday.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a holiday using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentHoliday</maml:name> <command:parameter required="true" position="0"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>End of the holiday.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the holiday.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Start of the holiday.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CalendarIds</maml:name> <maml:description> <maml:para>Identifiers of calendars of the holiday.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="8"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of holiday properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">HolidayField[]</command:parameterValue> <dev:type> <maml:name>HolidayField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>End of the holiday.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the holiday.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Start of the holiday.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CalendarIds</maml:name> <maml:description> <maml:para>Identifiers of calendars of the holiday.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="8"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of holiday properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">HolidayField[]</command:parameterValue> <dev:type> <maml:name>HolidayField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.HolidayField[]</maml:name> </dev:type> <maml:description> <maml:para>The holiday field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Holiday</maml:name> </dev:type> <maml:description> <maml:para>A holiday object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentHolidayQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentHolidayQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a holiday query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentHolidayQuery cmdlet creates and configures a holiday query object using the provided parameters. These result can be used with the Invoke-XurrentHolidayQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentHolidayQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the holiday query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a holiday properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">HolidayField[]</command:parameterValue> <dev:type> <maml:name>HolidayField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Calendars</maml:name> <maml:description> <maml:para>Specify the calendars details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<HolidayQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<HolidayQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<HolidayQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the holiday query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a holiday properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">HolidayField[]</command:parameterValue> <dev:type> <maml:name>HolidayField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Calendars</maml:name> <maml:description> <maml:para>Specify the calendars details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<HolidayQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<HolidayQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<HolidayQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.HolidayField[]</maml:name> </dev:type> <maml:description> <maml:para>The Holiday field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<HolidayQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A holiday query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HolidayQuery</maml:name> </dev:type> <maml:description> <maml:para>A holiday query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentHolidayQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentHolidayQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new holiday query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentHolidayQueryFilter cmdlet creates and configures a holiday query filter object using the provided parameters. These filters can be used with the New-XurrentHolidayQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentHolidayQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">HolidayFilter</command:parameterValue> <dev:type> <maml:name>HolidayFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">HolidayFilter</command:parameterValue> <dev:type> <maml:name>HolidayFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.HolidayFilter</maml:name> </dev:type> <maml:description> <maml:para>a holiday filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<HolidayQuery></maml:name> </dev:type> <maml:description> <maml:para>A holiday query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentInboundEmailQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentInboundEmailQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an inbound email query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentInboundEmailQuery cmdlet creates and configures an inbound email query object using the provided parameters. These result can be used with the Invoke-XurrentInboundEmailQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentInboundEmailQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an inbound email properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InboundEmailField[]</command:parameterValue> <dev:type> <maml:name>InboundEmailField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Note</maml:name> <maml:description> <maml:para>Specify the note details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>RecordProblem</maml:name> <maml:description> <maml:para>Specify the record Problem to be returned using a problem query. This only applies if the item is a problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>RecordProject</maml:name> <maml:description> <maml:para>Specify the record Project to be returned using a project query. This only applies if the item is a project.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>RecordProjectTask</maml:name> <maml:description> <maml:para>Specify the record Project task to be returned using a project task query. This only applies if the item is a project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>RecordRelease</maml:name> <maml:description> <maml:para>Specify the record Release to be returned using a release query. This only applies if the item is a release.</maml:para> </maml:description> <command:parameterValue required="false">ReleaseQuery</command:parameterValue> <dev:type> <maml:name>ReleaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>RecordRequest</maml:name> <maml:description> <maml:para>Specify the record Request to be returned using a request query. This only applies if the item is a request.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>RecordRisk</maml:name> <maml:description> <maml:para>Specify the record Risk to be returned using a risk query. This only applies if the item is a risk.</maml:para> </maml:description> <command:parameterValue required="false">RiskQuery</command:parameterValue> <dev:type> <maml:name>RiskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>RecordTask</maml:name> <maml:description> <maml:para>Specify the record Task to be returned using a task query. This only applies if the item is a task.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RecordWorkflow</maml:name> <maml:description> <maml:para>Specify the record Workflow to be returned using a workflow query. This only applies if the item is a workflow.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an inbound email properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InboundEmailField[]</command:parameterValue> <dev:type> <maml:name>InboundEmailField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Note</maml:name> <maml:description> <maml:para>Specify the note details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>RecordProblem</maml:name> <maml:description> <maml:para>Specify the record Problem to be returned using a problem query. This only applies if the item is a problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>RecordProject</maml:name> <maml:description> <maml:para>Specify the record Project to be returned using a project query. This only applies if the item is a project.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>RecordProjectTask</maml:name> <maml:description> <maml:para>Specify the record Project task to be returned using a project task query. This only applies if the item is a project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>RecordRelease</maml:name> <maml:description> <maml:para>Specify the record Release to be returned using a release query. This only applies if the item is a release.</maml:para> </maml:description> <command:parameterValue required="false">ReleaseQuery</command:parameterValue> <dev:type> <maml:name>ReleaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>RecordRequest</maml:name> <maml:description> <maml:para>Specify the record Request to be returned using a request query. This only applies if the item is a request.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>RecordRisk</maml:name> <maml:description> <maml:para>Specify the record Risk to be returned using a risk query. This only applies if the item is a risk.</maml:para> </maml:description> <command:parameterValue required="false">RiskQuery</command:parameterValue> <dev:type> <maml:name>RiskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>RecordTask</maml:name> <maml:description> <maml:para>Specify the record Task to be returned using a task query. This only applies if the item is a task.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RecordWorkflow</maml:name> <maml:description> <maml:para>Specify the record Workflow to be returned using a workflow query. This only applies if the item is a workflow.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InboundEmailField[]</maml:name> </dev:type> <maml:description> <maml:para>The Inbound email field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteQuery</maml:name> </dev:type> <maml:description> <maml:para>A note query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemQuery</maml:name> </dev:type> <maml:description> <maml:para>A problem query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectQuery</maml:name> </dev:type> <maml:description> <maml:para>A project query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReleaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A release query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskQuery</maml:name> </dev:type> <maml:description> <maml:para>A risk query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>InboundEmailQuery</maml:name> </dev:type> <maml:description> <maml:para>An inbound email query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentInvoice</command:name> <command:verb>New</command:verb> <command:noun>XurrentInvoice</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new invoice.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates an invoice using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentInvoice</maml:name> <command:parameter required="true" position="0"> <maml:name>Description</maml:name> <maml:description> <maml:para>Short description of what was acquired.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>InvoiceDate</maml:name> <maml:description> <maml:para>The date on which the invoice was sent out by the supplier.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>InvoiceNr</maml:name> <maml:description> <maml:para>The invoice number that the supplier specified on the invoice.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Quantity</maml:name> <maml:description> <maml:para>The number of units that were acquired.</maml:para> </maml:description> <command:parameterValue required="true">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the organization from which the invoice was received.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>UnitPrice</maml:name> <maml:description> <maml:para>The amount that the supplier has charged per unit that was acquired.</maml:para> </maml:description> <command:parameterValue required="true">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AmortizationEnd</maml:name> <maml:description> <maml:para>The end date of the period over which the invoice is to be amortized.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AmortizationStart</maml:name> <maml:description> <maml:para>The start date of the period over which the invoice is to be amortized.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Amortize</maml:name> <maml:description> <maml:para>Whether the invoice amount is to be amortized over time.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CiIds</maml:name> <maml:description> <maml:para>The configuration items linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ContractId</maml:name> <maml:description> <maml:para>The contract linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Currency</maml:name> <maml:description> <maml:para>Currency of the amount value of the invoice.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>DepreciationMethod</maml:name> <maml:description> <maml:para>Used to specify whether or not configuration items that are linked to this invoice are depreciatedand if so, which depreciation method is to be applied. Valid values are:• not_depreciated: Not Depreciated• double_declining_balance: Double Declining Balance• reducing_balance: Reducing Balance (or Diminishing Value)• straight_line: Straight Line (or Prime Cost)• sum_of_the_years_digits: Sum of the Year's Digits</maml:para> </maml:description> <command:parameterValue required="false">ProductDepreciationMethod</command:parameterValue> <dev:type> <maml:name>ProductDepreciationMethod</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>DepreciationStart</maml:name> <maml:description> <maml:para>The date on which to start depreciating the asset.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>FinancialID</maml:name> <maml:description> <maml:para>The unique identifier by which the invoice is known in the financial system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>FlsaId</maml:name> <maml:description> <maml:para>The first line support agreement linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>PoNr</maml:name> <maml:description> <maml:para>Number of the purchase order that was used to order the (lease of the) configuration item from the supplier.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>The project linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Rate</maml:name> <maml:description> <maml:para>Used to specify the yearly rate that should be applied to calculate the depreciation of the configuration item (CI) using the reducing balance (or diminishing value) method. When creating a new CI and a value is not specified for this field, it is set to the rate of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the invoice that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SalvageValue</maml:name> <maml:description> <maml:para>The value of this configuration item at the end of its useful life (i.e. at the end of its depreciation period). When a value is not specified for this field, it is set to zero.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>SalvageValueCurrency</maml:name> <maml:description> <maml:para>The currency of the salvage value attributed to this configuration item.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>The service that covers this invoice. Can only be set when the invoice is linked to a contract or configuration items.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SlaId</maml:name> <maml:description> <maml:para>The service level agreement linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>UsefulLife</maml:name> <maml:description> <maml:para>The number of years within which the configuration item is to be depreciated. When creating a new CI and a value is not specified for this field, it is set to the useful life of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>The workflow linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="30"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of invoice properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InvoiceField[]</command:parameterValue> <dev:type> <maml:name>InvoiceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Description</maml:name> <maml:description> <maml:para>Short description of what was acquired.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>InvoiceDate</maml:name> <maml:description> <maml:para>The date on which the invoice was sent out by the supplier.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>InvoiceNr</maml:name> <maml:description> <maml:para>The invoice number that the supplier specified on the invoice.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Quantity</maml:name> <maml:description> <maml:para>The number of units that were acquired.</maml:para> </maml:description> <command:parameterValue required="true">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the organization from which the invoice was received.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>UnitPrice</maml:name> <maml:description> <maml:para>The amount that the supplier has charged per unit that was acquired.</maml:para> </maml:description> <command:parameterValue required="true">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AmortizationEnd</maml:name> <maml:description> <maml:para>The end date of the period over which the invoice is to be amortized.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AmortizationStart</maml:name> <maml:description> <maml:para>The start date of the period over which the invoice is to be amortized.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Amortize</maml:name> <maml:description> <maml:para>Whether the invoice amount is to be amortized over time.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CiIds</maml:name> <maml:description> <maml:para>The configuration items linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ContractId</maml:name> <maml:description> <maml:para>The contract linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Currency</maml:name> <maml:description> <maml:para>Currency of the amount value of the invoice.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>DepreciationMethod</maml:name> <maml:description> <maml:para>Used to specify whether or not configuration items that are linked to this invoice are depreciatedand if so, which depreciation method is to be applied. Valid values are:• not_depreciated: Not Depreciated• double_declining_balance: Double Declining Balance• reducing_balance: Reducing Balance (or Diminishing Value)• straight_line: Straight Line (or Prime Cost)• sum_of_the_years_digits: Sum of the Year's Digits</maml:para> </maml:description> <command:parameterValue required="false">ProductDepreciationMethod</command:parameterValue> <dev:type> <maml:name>ProductDepreciationMethod</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>DepreciationStart</maml:name> <maml:description> <maml:para>The date on which to start depreciating the asset.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>FinancialID</maml:name> <maml:description> <maml:para>The unique identifier by which the invoice is known in the financial system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>FlsaId</maml:name> <maml:description> <maml:para>The first line support agreement linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>PoNr</maml:name> <maml:description> <maml:para>Number of the purchase order that was used to order the (lease of the) configuration item from the supplier.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>The project linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Rate</maml:name> <maml:description> <maml:para>Used to specify the yearly rate that should be applied to calculate the depreciation of the configuration item (CI) using the reducing balance (or diminishing value) method. When creating a new CI and a value is not specified for this field, it is set to the rate of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the invoice that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SalvageValue</maml:name> <maml:description> <maml:para>The value of this configuration item at the end of its useful life (i.e. at the end of its depreciation period). When a value is not specified for this field, it is set to zero.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>SalvageValueCurrency</maml:name> <maml:description> <maml:para>The currency of the salvage value attributed to this configuration item.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>The service that covers this invoice. Can only be set when the invoice is linked to a contract or configuration items.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SlaId</maml:name> <maml:description> <maml:para>The service level agreement linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>UsefulLife</maml:name> <maml:description> <maml:para>The number of years within which the configuration item is to be depreciated. When creating a new CI and a value is not specified for this field, it is set to the useful life of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>The workflow linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="30"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of invoice properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InvoiceField[]</command:parameterValue> <dev:type> <maml:name>InvoiceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductDepreciationMethod</maml:name> </dev:type> <maml:description> <maml:para>A product depreciation method object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InvoiceField[]</maml:name> </dev:type> <maml:description> <maml:para>The invoice field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Invoice</maml:name> </dev:type> <maml:description> <maml:para>An invoice object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentInvoiceQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentInvoiceQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an invoice query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentInvoiceQuery cmdlet creates and configures an invoice query object using the provided parameters. These result can be used with the Invoke-XurrentInvoiceQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentInvoiceQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the invoice query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an invoice properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InvoiceField[]</command:parameterValue> <dev:type> <maml:name>InvoiceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceView</command:parameterValue> <dev:type> <maml:name>InvoiceView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceOrderField</command:parameterValue> <dev:type> <maml:name>InvoiceOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Contract</maml:name> <maml:description> <maml:para>Specify the contract details to be returned using a contract query.</maml:para> </maml:description> <command:parameterValue required="false">ContractQuery</command:parameterValue> <dev:type> <maml:name>ContractQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Flsa</maml:name> <maml:description> <maml:para>Specify the flsa details to be returned using a first line support agreement query.</maml:para> </maml:description> <command:parameterValue required="false">FirstLineSupportAgreementQuery</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specify the project details to be returned using a project query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Sla</maml:name> <maml:description> <maml:para>Specify the SLA details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Specify the workflow details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<InvoiceQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<InvoiceQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<InvoiceQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the invoice query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an invoice properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InvoiceField[]</command:parameterValue> <dev:type> <maml:name>InvoiceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceView</command:parameterValue> <dev:type> <maml:name>InvoiceView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceOrderField</command:parameterValue> <dev:type> <maml:name>InvoiceOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Contract</maml:name> <maml:description> <maml:para>Specify the contract details to be returned using a contract query.</maml:para> </maml:description> <command:parameterValue required="false">ContractQuery</command:parameterValue> <dev:type> <maml:name>ContractQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Flsa</maml:name> <maml:description> <maml:para>Specify the flsa details to be returned using a first line support agreement query.</maml:para> </maml:description> <command:parameterValue required="false">FirstLineSupportAgreementQuery</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specify the project details to be returned using a project query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Sla</maml:name> <maml:description> <maml:para>Specify the SLA details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Specify the workflow details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<InvoiceQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<InvoiceQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<InvoiceQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InvoiceField[]</maml:name> </dev:type> <maml:description> <maml:para>The Invoice field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InvoiceView</maml:name> </dev:type> <maml:description> <maml:para>The invoice view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InvoiceOrderField</maml:name> </dev:type> <maml:description> <maml:para>The invoice order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContractQuery</maml:name> </dev:type> <maml:description> <maml:para>A contract query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FirstLineSupportAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A first line support agreement query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectQuery</maml:name> </dev:type> <maml:description> <maml:para>A project query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<InvoiceQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>An invoice query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> <maml:description> <maml:para>An invoice query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentInvoiceQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentInvoiceQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new invoice query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentInvoiceQueryFilter cmdlet creates and configures an invoice query filter object using the provided parameters. These filters can be used with the New-XurrentInvoiceQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentInvoiceQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">InvoiceFilter</command:parameterValue> <dev:type> <maml:name>InvoiceFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">InvoiceFilter</command:parameterValue> <dev:type> <maml:name>InvoiceFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InvoiceFilter</maml:name> </dev:type> <maml:description> <maml:para>an invoice filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<InvoiceQuery></maml:name> </dev:type> <maml:description> <maml:para>An invoice query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentKnowledgeArticle</command:name> <command:verb>New</command:verb> <command:noun>XurrentKnowledgeArticle</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new knowledge article.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a knowledge article using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentKnowledgeArticle</maml:name> <command:parameter required="true" position="0"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Used to enter instructions for the service desk analysts, specialists and/or end users who are likely to look up the knowledge article to help them with their work or to resolve an issue.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the knowledge article is made available.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the knowledge article.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ArchiveDate</maml:name> <maml:description> <maml:para>The date until which the knowledge article will be active. The knowledge article will be archived at the beginning of this day. When the knowledge article is archived, its status will automatically be set to "Archived".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CoveredSpecialists</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to the people who are a member of the support team of one of the service instances that are selected in the Coverage section of an active SLA for the service that is linked to the article.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CreatedById</maml:name> <maml:description> <maml:para>Identifier of the person who created the knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Description</maml:name> <maml:description> <maml:para>Describes the situation and/or environment in which the instructions of the knowledge article may be helpful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>EndUsers</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to anyone who is covered by an active SLA for the service that is linked to the article.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>InternalSpecialists</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to the people who have the Specialist role of the account in which the article is registered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>KeyContacts</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to the people who have the Key Contact role of the customer account of an active SLA for the service that is linked to the article.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Keywords</maml:name> <maml:description> <maml:para>A comma-separated list of words that can be used to find the knowledge article using search.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Public</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to anyone, including people without access to Xurrent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of service instances linked to this knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleStatus</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>Identifier of the knowledge article template that this knowledge article is based on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="21"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of knowledge article properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">KnowledgeArticleField[]</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Used to enter instructions for the service desk analysts, specialists and/or end users who are likely to look up the knowledge article to help them with their work or to resolve an issue.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the knowledge article is made available.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the knowledge article.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ArchiveDate</maml:name> <maml:description> <maml:para>The date until which the knowledge article will be active. The knowledge article will be archived at the beginning of this day. When the knowledge article is archived, its status will automatically be set to "Archived".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CoveredSpecialists</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to the people who are a member of the support team of one of the service instances that are selected in the Coverage section of an active SLA for the service that is linked to the article.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CreatedById</maml:name> <maml:description> <maml:para>Identifier of the person who created the knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Description</maml:name> <maml:description> <maml:para>Describes the situation and/or environment in which the instructions of the knowledge article may be helpful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>EndUsers</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to anyone who is covered by an active SLA for the service that is linked to the article.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>InternalSpecialists</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to the people who have the Specialist role of the account in which the article is registered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>KeyContacts</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to the people who have the Key Contact role of the customer account of an active SLA for the service that is linked to the article.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Keywords</maml:name> <maml:description> <maml:para>A comma-separated list of words that can be used to find the knowledge article using search.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Public</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to anyone, including people without access to Xurrent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of service instances linked to this knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleStatus</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>Identifier of the knowledge article template that this knowledge article is based on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="21"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of knowledge article properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">KnowledgeArticleField[]</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleStatus</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleField[]</maml:name> </dev:type> <maml:description> <maml:para>The knowledge article field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>KnowledgeArticle</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentKnowledgeArticleQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentKnowledgeArticleQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a knowledge article query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentKnowledgeArticleQuery cmdlet creates and configures a knowledge article query object using the provided parameters. These result can be used with the Invoke-XurrentKnowledgeArticleQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentKnowledgeArticleQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the knowledge article query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a knowledge article properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">KnowledgeArticleField[]</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleView</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleOrderField</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Specify the created by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Requests</maml:name> <maml:description> <maml:para>Specify the requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specify the template details to be returned using a knowledge article template query.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleTemplateQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>UpdatedBy</maml:name> <maml:description> <maml:para>Specify the updated by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<KnowledgeArticleQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<KnowledgeArticleQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<KnowledgeArticleQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the knowledge article query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a knowledge article properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">KnowledgeArticleField[]</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleView</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleOrderField</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Specify the created by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Requests</maml:name> <maml:description> <maml:para>Specify the requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specify the template details to be returned using a knowledge article template query.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleTemplateQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>UpdatedBy</maml:name> <maml:description> <maml:para>Specify the updated by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<KnowledgeArticleQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<KnowledgeArticleQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<KnowledgeArticleQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleField[]</maml:name> </dev:type> <maml:description> <maml:para>The Knowledge article field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleView</maml:name> </dev:type> <maml:description> <maml:para>The knowledge article view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleOrderField</maml:name> </dev:type> <maml:description> <maml:para>The knowledge article order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<KnowledgeArticleQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>KnowledgeArticleQuery</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentKnowledgeArticleQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentKnowledgeArticleQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new knowledge article query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentKnowledgeArticleQueryFilter cmdlet creates and configures a knowledge article query filter object using the provided parameters. These filters can be used with the New-XurrentKnowledgeArticleQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentKnowledgeArticleQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">KnowledgeArticleFilter</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">KnowledgeArticleFilter</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleFilter</maml:name> </dev:type> <maml:description> <maml:para>a knowledge article filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<KnowledgeArticleQuery></maml:name> </dev:type> <maml:description> <maml:para>A knowledge article query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentKnowledgeArticleTemplateQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentKnowledgeArticleTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a knowledge article template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentKnowledgeArticleTemplateQuery cmdlet creates and configures a knowledge article template query object using the provided parameters. These result can be used with the Invoke-XurrentKnowledgeArticleTemplateQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentKnowledgeArticleTemplateQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the knowledge article template query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a knowledge article template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">KnowledgeArticleTemplateField[]</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleTemplateView</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleTemplateView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleTemplateOrderField</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleTemplateOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<KnowledgeArticleTemplateQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<KnowledgeArticleTemplateQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<KnowledgeArticleTemplateQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the knowledge article template query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a knowledge article template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">KnowledgeArticleTemplateField[]</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleTemplateView</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleTemplateView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleTemplateOrderField</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleTemplateOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<KnowledgeArticleTemplateQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<KnowledgeArticleTemplateQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<KnowledgeArticleTemplateQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The Knowledge article template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleTemplateView</maml:name> </dev:type> <maml:description> <maml:para>The knowledge article template view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleTemplateOrderField</maml:name> </dev:type> <maml:description> <maml:para>The knowledge article template order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<KnowledgeArticleTemplateQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article template query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>KnowledgeArticleTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article template query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentKnowledgeArticleTemplateQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentKnowledgeArticleTemplateQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new knowledge article template query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentKnowledgeArticleTemplateQueryFilter cmdlet creates and configures a knowledge article template query filter object using the provided parameters. These filters can be used with the New-XurrentKnowledgeArticleTemplateQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentKnowledgeArticleTemplateQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">KnowledgeArticleTemplateFilter</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleTemplateFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">KnowledgeArticleTemplateFilter</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleTemplateFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleTemplateFilter</maml:name> </dev:type> <maml:description> <maml:para>a knowledge article template filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<KnowledgeArticleTemplateQuery></maml:name> </dev:type> <maml:description> <maml:para>A knowledge article template query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentMeQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentMeQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a me query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentMeQuery cmdlet creates and configures a me query object using the provided parameters. These result can be used with the Invoke-XurrentMeQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentMeQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a me properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PersonField[]</command:parameterValue> <dev:type> <maml:name>PersonField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Addresses</maml:name> <maml:description> <maml:para>Specify the addresses details to be returned using an address query.</maml:para> </maml:description> <command:parameterValue required="false">AddressQuery</command:parameterValue> <dev:type> <maml:name>AddressQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Cart</maml:name> <maml:description> <maml:para>Specify the cart details to be returned using a shop order line query.</maml:para> </maml:description> <command:parameterValue required="false">ShopOrderLineQuery</command:parameterValue> <dev:type> <maml:name>ShopOrderLineQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Contacts</maml:name> <maml:description> <maml:para>Specify the contacts details to be returned using a contact query.</maml:para> </maml:description> <command:parameterValue required="false">ContactQuery</command:parameterValue> <dev:type> <maml:name>ContactQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Specify the organization details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>OutOfOfficePeriods</maml:name> <maml:description> <maml:para>Specify the out of office periods details to be returned using an out of office period query.</maml:para> </maml:description> <command:parameterValue required="false">OutOfOfficePeriodQuery</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Permissions</maml:name> <maml:description> <maml:para>Specify the permissions details to be returned using a permission query.</maml:para> </maml:description> <command:parameterValue required="false">PermissionQuery</command:parameterValue> <dev:type> <maml:name>PermissionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Site</maml:name> <maml:description> <maml:para>Specify the site details to be returned using a site query.</maml:para> </maml:description> <command:parameterValue required="false">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SkillPools</maml:name> <maml:description> <maml:para>Specify the skill pools details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Teams</maml:name> <maml:description> <maml:para>Specify the teams details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>WorkHours</maml:name> <maml:description> <maml:para>Specify the work hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a me properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PersonField[]</command:parameterValue> <dev:type> <maml:name>PersonField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Addresses</maml:name> <maml:description> <maml:para>Specify the addresses details to be returned using an address query.</maml:para> </maml:description> <command:parameterValue required="false">AddressQuery</command:parameterValue> <dev:type> <maml:name>AddressQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Cart</maml:name> <maml:description> <maml:para>Specify the cart details to be returned using a shop order line query.</maml:para> </maml:description> <command:parameterValue required="false">ShopOrderLineQuery</command:parameterValue> <dev:type> <maml:name>ShopOrderLineQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Contacts</maml:name> <maml:description> <maml:para>Specify the contacts details to be returned using a contact query.</maml:para> </maml:description> <command:parameterValue required="false">ContactQuery</command:parameterValue> <dev:type> <maml:name>ContactQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Specify the organization details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>OutOfOfficePeriods</maml:name> <maml:description> <maml:para>Specify the out of office periods details to be returned using an out of office period query.</maml:para> </maml:description> <command:parameterValue required="false">OutOfOfficePeriodQuery</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Permissions</maml:name> <maml:description> <maml:para>Specify the permissions details to be returned using a permission query.</maml:para> </maml:description> <command:parameterValue required="false">PermissionQuery</command:parameterValue> <dev:type> <maml:name>PermissionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Site</maml:name> <maml:description> <maml:para>Specify the site details to be returned using a site query.</maml:para> </maml:description> <command:parameterValue required="false">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SkillPools</maml:name> <maml:description> <maml:para>Specify the skill pools details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Teams</maml:name> <maml:description> <maml:para>Specify the teams details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>WorkHours</maml:name> <maml:description> <maml:para>Specify the work hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonField[]</maml:name> </dev:type> <maml:description> <maml:para>The Person field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressQuery</maml:name> </dev:type> <maml:description> <maml:para>An address query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopOrderLineQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop order line query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContactQuery</maml:name> </dev:type> <maml:description> <maml:para>A contact query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OutOfOfficePeriodQuery</maml:name> </dev:type> <maml:description> <maml:para>An out of office period query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PermissionQuery</maml:name> </dev:type> <maml:description> <maml:para>A permission query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SiteQuery</maml:name> </dev:type> <maml:description> <maml:para>A site query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolQuery</maml:name> </dev:type> <maml:description> <maml:para>A skill pool query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>MeQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentNote</command:name> <command:verb>New</command:verb> <command:noun>XurrentNote</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new note.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a note using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentNote</maml:name> <command:parameter required="true" position="0"> <maml:name>Text</maml:name> <maml:description> <maml:para>Text of the note.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Attachments</maml:name> <maml:description> <maml:para>The attachments used in the note field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Internal</maml:name> <maml:description> <maml:para>Whether the note should be visible only for people who have the Auditor, Specialist or Account Administrator role of the account. Internal notes are only available for Requests.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>The record that the note should be added to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SuppressNoteAddedNotifications</maml:name> <maml:description> <maml:para>Whether Note Added notifications for this note should be suppressed.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="6"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of note properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NoteField[]</command:parameterValue> <dev:type> <maml:name>NoteField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Text</maml:name> <maml:description> <maml:para>Text of the note.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Attachments</maml:name> <maml:description> <maml:para>The attachments used in the note field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Internal</maml:name> <maml:description> <maml:para>Whether the note should be visible only for people who have the Auditor, Specialist or Account Administrator role of the account. Internal notes are only available for Requests.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>The record that the note should be added to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SuppressNoteAddedNotifications</maml:name> <maml:description> <maml:para>Whether Note Added notifications for this note should be suppressed.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="6"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of note properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NoteField[]</command:parameterValue> <dev:type> <maml:name>NoteField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteField[]</maml:name> </dev:type> <maml:description> <maml:para>The note field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Note</maml:name> </dev:type> <maml:description> <maml:para>A note object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentNoteQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentNoteQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a note query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentNoteQuery cmdlet creates and configures a note query object using the provided parameters. These result can be used with the Invoke-XurrentNoteQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentNoteQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a note properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NoteField[]</command:parameterValue> <dev:type> <maml:name>NoteField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>InboundEmail</maml:name> <maml:description> <maml:para>Specify the inbound email details to be returned using an inbound email query.</maml:para> </maml:description> <command:parameterValue required="false">InboundEmailQuery</command:parameterValue> <dev:type> <maml:name>InboundEmailQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NoteReactions</maml:name> <maml:description> <maml:para>Specify the note reactions details to be returned using a note reaction query.</maml:para> </maml:description> <command:parameterValue required="false">NoteReactionQuery</command:parameterValue> <dev:type> <maml:name>NoteReactionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>TextAttachments</maml:name> <maml:description> <maml:para>Specify the text attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a note properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NoteField[]</command:parameterValue> <dev:type> <maml:name>NoteField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>InboundEmail</maml:name> <maml:description> <maml:para>Specify the inbound email details to be returned using an inbound email query.</maml:para> </maml:description> <command:parameterValue required="false">InboundEmailQuery</command:parameterValue> <dev:type> <maml:name>InboundEmailQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NoteReactions</maml:name> <maml:description> <maml:para>Specify the note reactions details to be returned using a note reaction query.</maml:para> </maml:description> <command:parameterValue required="false">NoteReactionQuery</command:parameterValue> <dev:type> <maml:name>NoteReactionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>TextAttachments</maml:name> <maml:description> <maml:para>Specify the text attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteField[]</maml:name> </dev:type> <maml:description> <maml:para>The Note field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InboundEmailQuery</maml:name> </dev:type> <maml:description> <maml:para>An inbound email query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteReactionQuery</maml:name> </dev:type> <maml:description> <maml:para>A note reaction query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> <maml:description> <maml:para>A note query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentNoteReaction</command:name> <command:verb>New</command:verb> <command:noun>XurrentNoteReaction</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new note reaction.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a note reaction using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentNoteReaction</maml:name> <command:parameter required="true" position="0"> <maml:name>NoteId</maml:name> <maml:description> <maml:para>The identifier of the note you want to add a reaction to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Reaction</maml:name> <maml:description> <maml:para>The type of reaction to add to the note. Valid values are:• 👍• 👎• 😀• 😕• 🎉• ❤️</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of note reaction properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NoteReactionField[]</command:parameterValue> <dev:type> <maml:name>NoteReactionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>NoteId</maml:name> <maml:description> <maml:para>The identifier of the note you want to add a reaction to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Reaction</maml:name> <maml:description> <maml:para>The type of reaction to add to the note. Valid values are:• 👍• 👎• 😀• 😕• 🎉• ❤️</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of note reaction properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NoteReactionField[]</command:parameterValue> <dev:type> <maml:name>NoteReactionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteReactionField[]</maml:name> </dev:type> <maml:description> <maml:para>The note reaction field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NoteReaction</maml:name> </dev:type> <maml:description> <maml:para>A note reaction object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentNoteReactionQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentNoteReactionQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a note reaction query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentNoteReactionQuery cmdlet creates and configures a note reaction query object using the provided parameters. These result can be used with the Invoke-XurrentNoteReactionQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentNoteReactionQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a note reaction properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NoteReactionField[]</command:parameterValue> <dev:type> <maml:name>NoteReactionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Note</maml:name> <maml:description> <maml:para>Specify the note details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a note reaction properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NoteReactionField[]</command:parameterValue> <dev:type> <maml:name>NoteReactionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Note</maml:name> <maml:description> <maml:para>Specify the note details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteReactionField[]</maml:name> </dev:type> <maml:description> <maml:para>The Note reaction field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteQuery</maml:name> </dev:type> <maml:description> <maml:para>A note query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NoteReactionQuery</maml:name> </dev:type> <maml:description> <maml:para>A note reaction query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentOrganization</command:name> <command:verb>New</command:verb> <command:noun>XurrentOrganization</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new organization.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates an organization using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentOrganization</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The full name of the organization.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>BusinessUnit</maml:name> <maml:description> <maml:para>Whether the organization needs to be treated as a separate entity from a reporting perspective. This checkbox is only available for internal organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>BusinessUnitOrganizationId</maml:name> <maml:description> <maml:para>Refers to itself if the organization is a business unit, or refers to the business unit that the organization belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the organization may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EndUserPrivacy</maml:name> <maml:description> <maml:para>Whether end users from this organization should be prevented from seeing information of other end users.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>FinancialID</maml:name> <maml:description> <maml:para>The unique identifier by which the organization is known in the financial system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager of the organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of the organization.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>NewContacts</maml:name> <maml:description> <maml:para>New or updated contacts of the organization.</maml:para> </maml:description> <command:parameterValue required="false">ContactInput[]</command:parameterValue> <dev:type> <maml:name>ContactInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ParentId</maml:name> <maml:description> <maml:para>The organization's parent organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Region</maml:name> <maml:description> <maml:para>Which region the organization belongs to. It is possible to select a previously entered region name or to enter a new one. The Region field of a business unit's child organizations cannot be modified, as it is automatically set to the same value as the Region field of the business unit.Examples of commonly used region names are:- Asia Pacific (APAC)- Europe, Middle East & Africa (EMEA)- North America (NA)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the organization that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SubstituteId</maml:name> <maml:description> <maml:para>The person who acts as the substitute of the organization's manager.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TimeAllocationIds</maml:name> <maml:description> <maml:para>Time allocations of the organization.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="22"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of organization properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">OrganizationField[]</command:parameterValue> <dev:type> <maml:name>OrganizationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The full name of the organization.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>BusinessUnit</maml:name> <maml:description> <maml:para>Whether the organization needs to be treated as a separate entity from a reporting perspective. This checkbox is only available for internal organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>BusinessUnitOrganizationId</maml:name> <maml:description> <maml:para>Refers to itself if the organization is a business unit, or refers to the business unit that the organization belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the organization may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EndUserPrivacy</maml:name> <maml:description> <maml:para>Whether end users from this organization should be prevented from seeing information of other end users.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>FinancialID</maml:name> <maml:description> <maml:para>The unique identifier by which the organization is known in the financial system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager of the organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of the organization.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>NewContacts</maml:name> <maml:description> <maml:para>New or updated contacts of the organization.</maml:para> </maml:description> <command:parameterValue required="false">ContactInput[]</command:parameterValue> <dev:type> <maml:name>ContactInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ParentId</maml:name> <maml:description> <maml:para>The organization's parent organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Region</maml:name> <maml:description> <maml:para>Which region the organization belongs to. It is possible to select a previously entered region name or to enter a new one. The Region field of a business unit's child organizations cannot be modified, as it is automatically set to the same value as the Region field of the business unit.Examples of commonly used region names are:- Asia Pacific (APAC)- Europe, Middle East & Africa (EMEA)- North America (NA)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the organization that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SubstituteId</maml:name> <maml:description> <maml:para>The person who acts as the substitute of the organization's manager.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TimeAllocationIds</maml:name> <maml:description> <maml:para>Time allocations of the organization.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="22"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of organization properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">OrganizationField[]</command:parameterValue> <dev:type> <maml:name>OrganizationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressInput[]</maml:name> </dev:type> <maml:description> <maml:para>An address input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContactInput[]</maml:name> </dev:type> <maml:description> <maml:para>A contact input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationField[]</maml:name> </dev:type> <maml:description> <maml:para>The organization field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Organization</maml:name> </dev:type> <maml:description> <maml:para>An organization object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentOrganizationQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentOrganizationQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an organization query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentOrganizationQuery cmdlet creates and configures an organization query object using the provided parameters. These result can be used with the Invoke-XurrentOrganizationQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentOrganizationQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the organization query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an organization properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">OrganizationField[]</command:parameterValue> <dev:type> <maml:name>OrganizationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationView</command:parameterValue> <dev:type> <maml:name>OrganizationView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationOrderField</command:parameterValue> <dev:type> <maml:name>OrganizationOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Addresses</maml:name> <maml:description> <maml:para>Specify the addresses details to be returned using an address query.</maml:para> </maml:description> <command:parameterValue required="false">AddressQuery</command:parameterValue> <dev:type> <maml:name>AddressQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>BusinessUnitOrganization</maml:name> <maml:description> <maml:para>Specify the business unit organization details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ChildOrganizations</maml:name> <maml:description> <maml:para>Specify the child organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Contacts</maml:name> <maml:description> <maml:para>Specify the contacts details to be returned using a contact query.</maml:para> </maml:description> <command:parameterValue required="false">ContactQuery</command:parameterValue> <dev:type> <maml:name>ContactQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Contracts</maml:name> <maml:description> <maml:para>Specify the contracts details to be returned using a contract query.</maml:para> </maml:description> <command:parameterValue required="false">ContractQuery</command:parameterValue> <dev:type> <maml:name>ContractQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>OrderTemplate</maml:name> <maml:description> <maml:para>Specify the order template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Parent</maml:name> <maml:description> <maml:para>Specify the parent details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>People</maml:name> <maml:description> <maml:para>Specify the people details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Risks</maml:name> <maml:description> <maml:para>Specify the risks details to be returned using a risk query.</maml:para> </maml:description> <command:parameterValue required="false">RiskQuery</command:parameterValue> <dev:type> <maml:name>RiskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ServiceLevelAgreements</maml:name> <maml:description> <maml:para>Specify the service level agreements details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Substitute</maml:name> <maml:description> <maml:para>Specify the substitute details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>TimeAllocations</maml:name> <maml:description> <maml:para>Specify the time allocations details to be returned using a time allocation query.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationQuery</command:parameterValue> <dev:type> <maml:name>TimeAllocationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<OrganizationQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<OrganizationQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<OrganizationQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the organization query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an organization properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">OrganizationField[]</command:parameterValue> <dev:type> <maml:name>OrganizationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationView</command:parameterValue> <dev:type> <maml:name>OrganizationView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationOrderField</command:parameterValue> <dev:type> <maml:name>OrganizationOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Addresses</maml:name> <maml:description> <maml:para>Specify the addresses details to be returned using an address query.</maml:para> </maml:description> <command:parameterValue required="false">AddressQuery</command:parameterValue> <dev:type> <maml:name>AddressQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>BusinessUnitOrganization</maml:name> <maml:description> <maml:para>Specify the business unit organization details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ChildOrganizations</maml:name> <maml:description> <maml:para>Specify the child organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Contacts</maml:name> <maml:description> <maml:para>Specify the contacts details to be returned using a contact query.</maml:para> </maml:description> <command:parameterValue required="false">ContactQuery</command:parameterValue> <dev:type> <maml:name>ContactQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Contracts</maml:name> <maml:description> <maml:para>Specify the contracts details to be returned using a contract query.</maml:para> </maml:description> <command:parameterValue required="false">ContractQuery</command:parameterValue> <dev:type> <maml:name>ContractQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>OrderTemplate</maml:name> <maml:description> <maml:para>Specify the order template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Parent</maml:name> <maml:description> <maml:para>Specify the parent details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>People</maml:name> <maml:description> <maml:para>Specify the people details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Risks</maml:name> <maml:description> <maml:para>Specify the risks details to be returned using a risk query.</maml:para> </maml:description> <command:parameterValue required="false">RiskQuery</command:parameterValue> <dev:type> <maml:name>RiskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ServiceLevelAgreements</maml:name> <maml:description> <maml:para>Specify the service level agreements details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Substitute</maml:name> <maml:description> <maml:para>Specify the substitute details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>TimeAllocations</maml:name> <maml:description> <maml:para>Specify the time allocations details to be returned using a time allocation query.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationQuery</command:parameterValue> <dev:type> <maml:name>TimeAllocationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<OrganizationQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<OrganizationQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<OrganizationQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationField[]</maml:name> </dev:type> <maml:description> <maml:para>The Organization field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationView</maml:name> </dev:type> <maml:description> <maml:para>The organization view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationOrderField</maml:name> </dev:type> <maml:description> <maml:para>The organization order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressQuery</maml:name> </dev:type> <maml:description> <maml:para>An address query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContactQuery</maml:name> </dev:type> <maml:description> <maml:para>A contact query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContractQuery</maml:name> </dev:type> <maml:description> <maml:para>A contract query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A request template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskQuery</maml:name> </dev:type> <maml:description> <maml:para>A risk query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationQuery</maml:name> </dev:type> <maml:description> <maml:para>A time allocation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<OrganizationQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>An organization query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentOrganizationQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentOrganizationQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new organization query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentOrganizationQueryFilter cmdlet creates and configures an organization query filter object using the provided parameters. These filters can be used with the New-XurrentOrganizationQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentOrganizationQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">OrganizationFilter</command:parameterValue> <dev:type> <maml:name>OrganizationFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">OrganizationFilter</command:parameterValue> <dev:type> <maml:name>OrganizationFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationFilter</maml:name> </dev:type> <maml:description> <maml:para>an organization filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<OrganizationQuery></maml:name> </dev:type> <maml:description> <maml:para>An organization query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentOutOfOfficePeriod</command:name> <command:verb>New</command:verb> <command:noun>XurrentOutOfOfficePeriod</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new out of office period.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates an out of office period using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentOutOfOfficePeriod</maml:name> <command:parameter required="true" position="0"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>End time of the out of office period.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person who is out of office.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Start time of the out of office period.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ApprovalDelegateId</maml:name> <maml:description> <maml:para>Identifier of the person who is selected as the approval delegate for the out of office period.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Used to generate time entries for the out of office period. This field is required if the timesheet settings linked to the person's organization has one or more effort classes.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Reason</maml:name> <maml:description> <maml:para>The reason of the out of office period. Required when the description category of the time allocation is required.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>TimeAllocationId</maml:name> <maml:description> <maml:para>Used to generate time entries for the out of office period. Only the time allocations without service and customer that are linked to the person's organization can be selected. This field is required if at least one time allocation exists that meets those conditions.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of out of office period properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">OutOfOfficePeriodField[]</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>End time of the out of office period.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person who is out of office.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Start time of the out of office period.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ApprovalDelegateId</maml:name> <maml:description> <maml:para>Identifier of the person who is selected as the approval delegate for the out of office period.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Used to generate time entries for the out of office period. This field is required if the timesheet settings linked to the person's organization has one or more effort classes.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Reason</maml:name> <maml:description> <maml:para>The reason of the out of office period. Required when the description category of the time allocation is required.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>TimeAllocationId</maml:name> <maml:description> <maml:para>Used to generate time entries for the out of office period. Only the time allocations without service and customer that are linked to the person's organization can be selected. This field is required if at least one time allocation exists that meets those conditions.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of out of office period properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">OutOfOfficePeriodField[]</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OutOfOfficePeriodField[]</maml:name> </dev:type> <maml:description> <maml:para>The out of office period field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OutOfOfficePeriod</maml:name> </dev:type> <maml:description> <maml:para>An out of office period object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentOutOfOfficePeriodQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentOutOfOfficePeriodQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an out of office period query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentOutOfOfficePeriodQuery cmdlet creates and configures an out of office period query object using the provided parameters. These result can be used with the Invoke-XurrentOutOfOfficePeriodQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentOutOfOfficePeriodQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the out of office period query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an out of office period properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">OutOfOfficePeriodField[]</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OutOfOfficePeriodView</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OutOfOfficePeriodOrderField</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ApprovalDelegate</maml:name> <maml:description> <maml:para>Specify the approval delegate details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>TimeAllocation</maml:name> <maml:description> <maml:para>Specify the time allocation details to be returned using a time allocation query.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationQuery</command:parameterValue> <dev:type> <maml:name>TimeAllocationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<OutOfOfficePeriodQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<OutOfOfficePeriodQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<OutOfOfficePeriodQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the out of office period query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an out of office period properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">OutOfOfficePeriodField[]</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OutOfOfficePeriodView</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OutOfOfficePeriodOrderField</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ApprovalDelegate</maml:name> <maml:description> <maml:para>Specify the approval delegate details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>TimeAllocation</maml:name> <maml:description> <maml:para>Specify the time allocation details to be returned using a time allocation query.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationQuery</command:parameterValue> <dev:type> <maml:name>TimeAllocationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<OutOfOfficePeriodQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<OutOfOfficePeriodQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<OutOfOfficePeriodQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OutOfOfficePeriodField[]</maml:name> </dev:type> <maml:description> <maml:para>The Out of office period field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OutOfOfficePeriodView</maml:name> </dev:type> <maml:description> <maml:para>The out of office period view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OutOfOfficePeriodOrderField</maml:name> </dev:type> <maml:description> <maml:para>The out of office period order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationQuery</maml:name> </dev:type> <maml:description> <maml:para>A time allocation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<OutOfOfficePeriodQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>An out of office period query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OutOfOfficePeriodQuery</maml:name> </dev:type> <maml:description> <maml:para>An out of office period query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentOutOfOfficePeriodQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentOutOfOfficePeriodQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new out of office period query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentOutOfOfficePeriodQueryFilter cmdlet creates and configures an out of office period query filter object using the provided parameters. These filters can be used with the New-XurrentOutOfOfficePeriodQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentOutOfOfficePeriodQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">OutOfOfficePeriodFilter</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">OutOfOfficePeriodFilter</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OutOfOfficePeriodFilter</maml:name> </dev:type> <maml:description> <maml:para>an out of office period filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<OutOfOfficePeriodQuery></maml:name> </dev:type> <maml:description> <maml:para>An out of office period query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentParentServiceInstanceQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentParentServiceInstanceQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a parent service instance query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentParentServiceInstanceQuery cmdlet creates and configures a parent service instance query object using the provided parameters. These result can be used with the Invoke-XurrentParentServiceInstanceQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentParentServiceInstanceQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a parent service instance properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ParentServiceInstanceField[]</command:parameterValue> <dev:type> <maml:name>ParentServiceInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a parent service instance properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ParentServiceInstanceField[]</command:parameterValue> <dev:type> <maml:name>ParentServiceInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ParentServiceInstanceField[]</maml:name> </dev:type> <maml:description> <maml:para>The Parent service instance field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ParentServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A parent service instance query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentPdfDesign</command:name> <command:verb>New</command:verb> <command:noun>XurrentPdfDesign</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new pdf design.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a pdf design using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentPdfDesign</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the design.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>Category of the design.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignCategory</command:parameterValue> <dev:type> <maml:name>PdfDesignCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Css</maml:name> <maml:description> <maml:para>CSS of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Files and inline images linked to the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the design is to be used.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Html</maml:name> <maml:description> <maml:para>HTML of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of pdf design properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PdfDesignField[]</command:parameterValue> <dev:type> <maml:name>PdfDesignField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the design.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>Category of the design.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignCategory</command:parameterValue> <dev:type> <maml:name>PdfDesignCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Css</maml:name> <maml:description> <maml:para>CSS of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Files and inline images linked to the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the design is to be used.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Html</maml:name> <maml:description> <maml:para>HTML of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of pdf design properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PdfDesignField[]</command:parameterValue> <dev:type> <maml:name>PdfDesignField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PdfDesignCategory</maml:name> </dev:type> <maml:description> <maml:para>A pdf design category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PdfDesignField[]</maml:name> </dev:type> <maml:description> <maml:para>The pdf design field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PdfDesign</maml:name> </dev:type> <maml:description> <maml:para>A pdf design object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentPdfDesignQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentPdfDesignQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a pdf design query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentPdfDesignQuery cmdlet creates and configures a pdf design query object using the provided parameters. These result can be used with the Invoke-XurrentPdfDesignQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentPdfDesignQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the pdf design query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a pdf design properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PdfDesignField[]</command:parameterValue> <dev:type> <maml:name>PdfDesignField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<PdfDesignQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<PdfDesignQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<PdfDesignQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the pdf design query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a pdf design properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PdfDesignField[]</command:parameterValue> <dev:type> <maml:name>PdfDesignField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<PdfDesignQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<PdfDesignQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<PdfDesignQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PdfDesignField[]</maml:name> </dev:type> <maml:description> <maml:para>The Pdf design field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<PdfDesignQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A pdf design query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PdfDesignQuery</maml:name> </dev:type> <maml:description> <maml:para>A pdf design query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentPdfDesignQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentPdfDesignQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new pdf design query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentPdfDesignQueryFilter cmdlet creates and configures a pdf design query filter object using the provided parameters. These filters can be used with the New-XurrentPdfDesignQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentPdfDesignQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">PdfDesignFilter</command:parameterValue> <dev:type> <maml:name>PdfDesignFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">PdfDesignFilter</command:parameterValue> <dev:type> <maml:name>PdfDesignFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PdfDesignFilter</maml:name> </dev:type> <maml:description> <maml:para>a pdf design filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<PdfDesignQuery></maml:name> </dev:type> <maml:description> <maml:para>A pdf design query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentPeriodQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentPeriodQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a period query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentPeriodQuery cmdlet creates and configures a period query object using the provided parameters. These result can be used with the Invoke-XurrentPeriodQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentPeriodQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a period properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PeriodField[]</command:parameterValue> <dev:type> <maml:name>PeriodField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a period properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PeriodField[]</command:parameterValue> <dev:type> <maml:name>PeriodField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PeriodField[]</maml:name> </dev:type> <maml:description> <maml:para>The Period field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PeriodQuery</maml:name> </dev:type> <maml:description> <maml:para>A period query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentPermissionQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentPermissionQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a permission query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentPermissionQuery cmdlet creates and configures a permission query object using the provided parameters. These result can be used with the Invoke-XurrentPermissionQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentPermissionQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a permission properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PermissionField[]</command:parameterValue> <dev:type> <maml:name>PermissionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a permission properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PermissionField[]</command:parameterValue> <dev:type> <maml:name>PermissionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PermissionField[]</maml:name> </dev:type> <maml:description> <maml:para>The Permission field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PermissionQuery</maml:name> </dev:type> <maml:description> <maml:para>A permission query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentPerson</command:name> <command:verb>New</command:verb> <command:noun>XurrentPerson</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new person.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a person using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentPerson</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the person.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PrimaryEmail</maml:name> <maml:description> <maml:para>The email address to which email notifications are to be sent. This email address acts as the unique identifier for the person within the Xurrent account. This primary email address also acts as the person's login name if he/she is a user of the Xurrent service.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AuthenticationID</maml:name> <maml:description> <maml:para>Uniquely identify the user for Single Sign-On</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AutoTranslation</maml:name> <maml:description> <maml:para>Whether the person should be offered translations for texts that are written in languages other than the ones selected in the Language (language) and the Do not translate (do_not_translate_languages) arguments. Such texts are translated automatically into the language selected in the Language (language) argument.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Configuration items this person is related to as a user.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CostPerHour</maml:name> <maml:description> <maml:para>The person's estimated total cost per work hour for the service provider organization. The value in this argument should include the costs of the person's salary (or rate in case of a long-term contractor), office space, service subscriptions, training, etc.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CostPerHourCurrency</maml:name> <maml:description> <maml:para>The currency of the cost per hour value attributed to this person.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>true when the person may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>DoNotTranslateLanguages</maml:name> <maml:description> <maml:para>The languages that should not be translated automatically for the person. Translations will not be offered to the person for texts in any of these languages. Supported language codes are: en, nl, de, fr, es, pt, it, da, fi, sv, pl, cs, tr, ru, ar, id, fa, no, zh, ja, ko, he, hi, ms.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>EmployeeID</maml:name> <maml:description> <maml:para>The unique identifier for a person typically based on order of hire or association with an organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ExcludeTeamNotifications</maml:name> <maml:description> <maml:para>Whether team notifications should be excluded from all notifications.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the person that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>JobTitle</maml:name> <maml:description> <maml:para>The person's job title.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Language</maml:name> <maml:description> <maml:para>The language preference of the person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Location</maml:name> <maml:description> <maml:para>The name or number of the room, cubicle or area where the person has his/her primary work space.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager or supervisor to whom the person reports.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>NewAccountPermissions</maml:name> <maml:description> <maml:para>Permissions for specific accounts of this person to add or update. Permissions for other accounts will not be altered.</maml:para> </maml:description> <command:parameterValue required="false">PermissionInput[]</command:parameterValue> <dev:type> <maml:name>PermissionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of this person.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>NewContacts</maml:name> <maml:description> <maml:para>New or updated contacts of this person.</maml:para> </maml:description> <command:parameterValue required="false">ContactInput[]</command:parameterValue> <dev:type> <maml:name>ContactInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>OauthPersonEnablement</maml:name> <maml:description> <maml:para>An enabled OAuth person is mentionable and visible in suggest fields, just like a real person.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>The organization for which the person works as an employee or long-term contractor.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Permissions</maml:name> <maml:description> <maml:para>Permissions of this person. These will overwrite all existing permissions of this person.</maml:para> </maml:description> <command:parameterValue required="false">PermissionInput[]</command:parameterValue> <dev:type> <maml:name>PermissionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SendEmailNotifications</maml:name> <maml:description> <maml:para>Indicates when to send email notifications to the person.</maml:para> </maml:description> <command:parameterValue required="false">PersonSendEmailNotifications</command:parameterValue> <dev:type> <maml:name>PersonSendEmailNotifications</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>ShowNotificationPopup</maml:name> <maml:description> <maml:para>Indicates when to show a notification popup to the person.</maml:para> </maml:description> <command:parameterValue required="false">PersonShowNotificationPopup</command:parameterValue> <dev:type> <maml:name>PersonShowNotificationPopup</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>SiteId</maml:name> <maml:description> <maml:para>Where the person is stationed.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>Skill pools this person belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>SupportID</maml:name> <maml:description> <maml:para>A number or code that a service desk analyst can ask the person for when the person contacts the service desk for support.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>TeamIds</maml:name> <maml:description> <maml:para>Teams this person belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>TimeFormat24h</maml:name> <maml:description> <maml:para>Whether the person prefers to see times displayed within the Xurrent service in the 24-hour format or not (in which case the 12-hour format is applied).</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone in which the person normally resides.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Vip</maml:name> <maml:description> <maml:para>Whether the person is a very important person.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>WorkHoursId</maml:name> <maml:description> <maml:para>Calendar that represents the work hours of the person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="40"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of person properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PersonField[]</command:parameterValue> <dev:type> <maml:name>PersonField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the person.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PrimaryEmail</maml:name> <maml:description> <maml:para>The email address to which email notifications are to be sent. This email address acts as the unique identifier for the person within the Xurrent account. This primary email address also acts as the person's login name if he/she is a user of the Xurrent service.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AuthenticationID</maml:name> <maml:description> <maml:para>Uniquely identify the user for Single Sign-On</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AutoTranslation</maml:name> <maml:description> <maml:para>Whether the person should be offered translations for texts that are written in languages other than the ones selected in the Language (language) and the Do not translate (do_not_translate_languages) arguments. Such texts are translated automatically into the language selected in the Language (language) argument.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Configuration items this person is related to as a user.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CostPerHour</maml:name> <maml:description> <maml:para>The person's estimated total cost per work hour for the service provider organization. The value in this argument should include the costs of the person's salary (or rate in case of a long-term contractor), office space, service subscriptions, training, etc.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CostPerHourCurrency</maml:name> <maml:description> <maml:para>The currency of the cost per hour value attributed to this person.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>true when the person may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>DoNotTranslateLanguages</maml:name> <maml:description> <maml:para>The languages that should not be translated automatically for the person. Translations will not be offered to the person for texts in any of these languages. Supported language codes are: en, nl, de, fr, es, pt, it, da, fi, sv, pl, cs, tr, ru, ar, id, fa, no, zh, ja, ko, he, hi, ms.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>EmployeeID</maml:name> <maml:description> <maml:para>The unique identifier for a person typically based on order of hire or association with an organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ExcludeTeamNotifications</maml:name> <maml:description> <maml:para>Whether team notifications should be excluded from all notifications.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the person that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>JobTitle</maml:name> <maml:description> <maml:para>The person's job title.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Language</maml:name> <maml:description> <maml:para>The language preference of the person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Location</maml:name> <maml:description> <maml:para>The name or number of the room, cubicle or area where the person has his/her primary work space.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager or supervisor to whom the person reports.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>NewAccountPermissions</maml:name> <maml:description> <maml:para>Permissions for specific accounts of this person to add or update. Permissions for other accounts will not be altered.</maml:para> </maml:description> <command:parameterValue required="false">PermissionInput[]</command:parameterValue> <dev:type> <maml:name>PermissionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of this person.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>NewContacts</maml:name> <maml:description> <maml:para>New or updated contacts of this person.</maml:para> </maml:description> <command:parameterValue required="false">ContactInput[]</command:parameterValue> <dev:type> <maml:name>ContactInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>OauthPersonEnablement</maml:name> <maml:description> <maml:para>An enabled OAuth person is mentionable and visible in suggest fields, just like a real person.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>The organization for which the person works as an employee or long-term contractor.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Permissions</maml:name> <maml:description> <maml:para>Permissions of this person. These will overwrite all existing permissions of this person.</maml:para> </maml:description> <command:parameterValue required="false">PermissionInput[]</command:parameterValue> <dev:type> <maml:name>PermissionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SendEmailNotifications</maml:name> <maml:description> <maml:para>Indicates when to send email notifications to the person.</maml:para> </maml:description> <command:parameterValue required="false">PersonSendEmailNotifications</command:parameterValue> <dev:type> <maml:name>PersonSendEmailNotifications</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>ShowNotificationPopup</maml:name> <maml:description> <maml:para>Indicates when to show a notification popup to the person.</maml:para> </maml:description> <command:parameterValue required="false">PersonShowNotificationPopup</command:parameterValue> <dev:type> <maml:name>PersonShowNotificationPopup</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>SiteId</maml:name> <maml:description> <maml:para>Where the person is stationed.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>Skill pools this person belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>SupportID</maml:name> <maml:description> <maml:para>A number or code that a service desk analyst can ask the person for when the person contacts the service desk for support.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>TeamIds</maml:name> <maml:description> <maml:para>Teams this person belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>TimeFormat24h</maml:name> <maml:description> <maml:para>Whether the person prefers to see times displayed within the Xurrent service in the 24-hour format or not (in which case the 12-hour format is applied).</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone in which the person normally resides.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Vip</maml:name> <maml:description> <maml:para>Whether the person is a very important person.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>WorkHoursId</maml:name> <maml:description> <maml:para>Calendar that represents the work hours of the person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="40"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of person properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PersonField[]</command:parameterValue> <dev:type> <maml:name>PersonField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PermissionInput[]</maml:name> </dev:type> <maml:description> <maml:para>A permission input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressInput[]</maml:name> </dev:type> <maml:description> <maml:para>An address input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContactInput[]</maml:name> </dev:type> <maml:description> <maml:para>A contact input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonSendEmailNotifications</maml:name> </dev:type> <maml:description> <maml:para>A person send email notifications object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonShowNotificationPopup</maml:name> </dev:type> <maml:description> <maml:para>A person show notification popup object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonField[]</maml:name> </dev:type> <maml:description> <maml:para>The person field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Person</maml:name> </dev:type> <maml:description> <maml:para>A person object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentPersonQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentPersonQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a person query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentPersonQuery cmdlet creates and configures a person query object using the provided parameters. These result can be used with the Invoke-XurrentPersonQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentPersonQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the person query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a person properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PersonField[]</command:parameterValue> <dev:type> <maml:name>PersonField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">PersonView</command:parameterValue> <dev:type> <maml:name>PersonView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">PersonOrderField</command:parameterValue> <dev:type> <maml:name>PersonOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Addresses</maml:name> <maml:description> <maml:para>Specify the addresses details to be returned using an address query.</maml:para> </maml:description> <command:parameterValue required="false">AddressQuery</command:parameterValue> <dev:type> <maml:name>AddressQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Cart</maml:name> <maml:description> <maml:para>Specify the cart details to be returned using a shop order line query.</maml:para> </maml:description> <command:parameterValue required="false">ShopOrderLineQuery</command:parameterValue> <dev:type> <maml:name>ShopOrderLineQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Contacts</maml:name> <maml:description> <maml:para>Specify the contacts details to be returned using a contact query.</maml:para> </maml:description> <command:parameterValue required="false">ContactQuery</command:parameterValue> <dev:type> <maml:name>ContactQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Specify the organization details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>OutOfOfficePeriods</maml:name> <maml:description> <maml:para>Specify the out of office periods details to be returned using an out of office period query.</maml:para> </maml:description> <command:parameterValue required="false">OutOfOfficePeriodQuery</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Permissions</maml:name> <maml:description> <maml:para>Specify the permissions details to be returned using a permission query.</maml:para> </maml:description> <command:parameterValue required="false">PermissionQuery</command:parameterValue> <dev:type> <maml:name>PermissionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Site</maml:name> <maml:description> <maml:para>Specify the site details to be returned using a site query.</maml:para> </maml:description> <command:parameterValue required="false">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SkillPools</maml:name> <maml:description> <maml:para>Specify the skill pools details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Teams</maml:name> <maml:description> <maml:para>Specify the teams details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>WorkHours</maml:name> <maml:description> <maml:para>Specify the work hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<PersonQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<PersonQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<PersonQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the person query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a person properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PersonField[]</command:parameterValue> <dev:type> <maml:name>PersonField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">PersonView</command:parameterValue> <dev:type> <maml:name>PersonView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">PersonOrderField</command:parameterValue> <dev:type> <maml:name>PersonOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Addresses</maml:name> <maml:description> <maml:para>Specify the addresses details to be returned using an address query.</maml:para> </maml:description> <command:parameterValue required="false">AddressQuery</command:parameterValue> <dev:type> <maml:name>AddressQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Cart</maml:name> <maml:description> <maml:para>Specify the cart details to be returned using a shop order line query.</maml:para> </maml:description> <command:parameterValue required="false">ShopOrderLineQuery</command:parameterValue> <dev:type> <maml:name>ShopOrderLineQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Contacts</maml:name> <maml:description> <maml:para>Specify the contacts details to be returned using a contact query.</maml:para> </maml:description> <command:parameterValue required="false">ContactQuery</command:parameterValue> <dev:type> <maml:name>ContactQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Specify the organization details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>OutOfOfficePeriods</maml:name> <maml:description> <maml:para>Specify the out of office periods details to be returned using an out of office period query.</maml:para> </maml:description> <command:parameterValue required="false">OutOfOfficePeriodQuery</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Permissions</maml:name> <maml:description> <maml:para>Specify the permissions details to be returned using a permission query.</maml:para> </maml:description> <command:parameterValue required="false">PermissionQuery</command:parameterValue> <dev:type> <maml:name>PermissionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Site</maml:name> <maml:description> <maml:para>Specify the site details to be returned using a site query.</maml:para> </maml:description> <command:parameterValue required="false">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SkillPools</maml:name> <maml:description> <maml:para>Specify the skill pools details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Teams</maml:name> <maml:description> <maml:para>Specify the teams details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>WorkHours</maml:name> <maml:description> <maml:para>Specify the work hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<PersonQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<PersonQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<PersonQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonField[]</maml:name> </dev:type> <maml:description> <maml:para>The Person field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonView</maml:name> </dev:type> <maml:description> <maml:para>The person view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonOrderField</maml:name> </dev:type> <maml:description> <maml:para>The person order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressQuery</maml:name> </dev:type> <maml:description> <maml:para>An address query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopOrderLineQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop order line query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContactQuery</maml:name> </dev:type> <maml:description> <maml:para>A contact query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OutOfOfficePeriodQuery</maml:name> </dev:type> <maml:description> <maml:para>An out of office period query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PermissionQuery</maml:name> </dev:type> <maml:description> <maml:para>A permission query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SiteQuery</maml:name> </dev:type> <maml:description> <maml:para>A site query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolQuery</maml:name> </dev:type> <maml:description> <maml:para>A skill pool query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<PersonQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A person query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentPersonQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentPersonQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new person query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentPersonQueryFilter cmdlet creates and configures a person query filter object using the provided parameters. These filters can be used with the New-XurrentPersonQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentPersonQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">PersonFilter</command:parameterValue> <dev:type> <maml:name>PersonFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">PersonFilter</command:parameterValue> <dev:type> <maml:name>PersonFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonFilter</maml:name> </dev:type> <maml:description> <maml:para>a person filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<PersonQuery></maml:name> </dev:type> <maml:description> <maml:para>A person query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProblem</command:name> <command:verb>New</command:verb> <command:noun>XurrentProblem</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new problem.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a problem using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProblem</maml:name> <command:parameter required="true" position="0"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service in which instance(s) the problem resides.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the symptoms that the problem causes.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AnalysisTargetAt</maml:name> <maml:description> <maml:para>Used to specify when the current assignee needs to have completed the root cause analysis of the problem.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemCategory</command:parameterValue> <dev:type> <maml:name>ProblemCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of configuration items of this problem.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Impact</maml:name> <maml:description> <maml:para>Used to select the extent to which the service is impacted when an incident occurs that is caused by the problem. Defaults to none.</maml:para> </maml:description> <command:parameterValue required="false">ProblemImpact</command:parameterValue> <dev:type> <maml:name>ProblemImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>KnowledgeArticleId</maml:name> <maml:description> <maml:para>Identifier of the knowledge article which instructions should be followed to resolve incidents caused by this problem until a structural solution has been implemented.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>KnownError</maml:name> <maml:description> <maml:para>Whether the underlying cause of the problem has been found and a temporary workaround has been proposed.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the problem through root cause analysis, the proposal of a structural solution and ultimately its closure. Defaults to the current authenticated person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person to whom the problem is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Note</maml:name> <maml:description> <maml:para>Detailed description of the symptoms that are caused by the problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ProductBacklogEstimate</maml:name> <maml:description> <maml:para>Estimate of the relative size of this item on the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ProductBacklogId</maml:name> <maml:description> <maml:para>Identifier of the product backlog this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ProductBacklogPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item on the backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>Identifier of the project to link the problem to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>RequestIds</maml:name> <maml:description> <maml:para>Identifiers of requests of this problem.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of service instances of this problem.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemStatus</command:parameterValue> <dev:type> <maml:name>ProblemStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that has been asked for a solution to the problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request to help with the solution of the problem has been registered at the supplier organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team to which the problem is to be assigned. Defaults to the support team of the service if no team or member is present.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether the problem has been marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the problem is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>Workaround</maml:name> <maml:description> <maml:para>Used to describe the temporary workaround that should be applied to resolve incidents caused by this problem until a structural solution has been implemented.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>Identifier of the workflow that will implement the proposed permanent solution for the problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="36"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of problem properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProblemField[]</command:parameterValue> <dev:type> <maml:name>ProblemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service in which instance(s) the problem resides.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the symptoms that the problem causes.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AnalysisTargetAt</maml:name> <maml:description> <maml:para>Used to specify when the current assignee needs to have completed the root cause analysis of the problem.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemCategory</command:parameterValue> <dev:type> <maml:name>ProblemCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of configuration items of this problem.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Impact</maml:name> <maml:description> <maml:para>Used to select the extent to which the service is impacted when an incident occurs that is caused by the problem. Defaults to none.</maml:para> </maml:description> <command:parameterValue required="false">ProblemImpact</command:parameterValue> <dev:type> <maml:name>ProblemImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>KnowledgeArticleId</maml:name> <maml:description> <maml:para>Identifier of the knowledge article which instructions should be followed to resolve incidents caused by this problem until a structural solution has been implemented.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>KnownError</maml:name> <maml:description> <maml:para>Whether the underlying cause of the problem has been found and a temporary workaround has been proposed.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the problem through root cause analysis, the proposal of a structural solution and ultimately its closure. Defaults to the current authenticated person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person to whom the problem is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Note</maml:name> <maml:description> <maml:para>Detailed description of the symptoms that are caused by the problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ProductBacklogEstimate</maml:name> <maml:description> <maml:para>Estimate of the relative size of this item on the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ProductBacklogId</maml:name> <maml:description> <maml:para>Identifier of the product backlog this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ProductBacklogPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item on the backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>Identifier of the project to link the problem to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>RequestIds</maml:name> <maml:description> <maml:para>Identifiers of requests of this problem.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of service instances of this problem.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemStatus</command:parameterValue> <dev:type> <maml:name>ProblemStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that has been asked for a solution to the problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request to help with the solution of the problem has been registered at the supplier organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team to which the problem is to be assigned. Defaults to the support team of the service if no team or member is present.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether the problem has been marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the problem is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>Workaround</maml:name> <maml:description> <maml:para>Used to describe the temporary workaround that should be applied to resolve incidents caused by this problem until a structural solution has been implemented.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>Identifier of the workflow that will implement the proposed permanent solution for the problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="36"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of problem properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProblemField[]</command:parameterValue> <dev:type> <maml:name>ProblemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemCategory</maml:name> </dev:type> <maml:description> <maml:para>A problem category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemImpact</maml:name> </dev:type> <maml:description> <maml:para>A problem impact object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemStatus</maml:name> </dev:type> <maml:description> <maml:para>A problem status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemField[]</maml:name> </dev:type> <maml:description> <maml:para>The problem field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Problem</maml:name> </dev:type> <maml:description> <maml:para>A problem object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProblemQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProblemQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a problem query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProblemQuery cmdlet creates and configures a problem query object using the provided parameters. These result can be used with the Invoke-XurrentProblemQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProblemQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the problem query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a problem properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProblemField[]</command:parameterValue> <dev:type> <maml:name>ProblemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProblemView</command:parameterValue> <dev:type> <maml:name>ProblemView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProblemOrderField</command:parameterValue> <dev:type> <maml:name>ProblemOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AgileBoardColumn</maml:name> <maml:description> <maml:para>Specify the agile board column details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>KnowledgeArticle</maml:name> <maml:description> <maml:para>Specify the knowledge article details to be returned using a knowledge article query.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specify the member details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProductBacklog</maml:name> <maml:description> <maml:para>Specify the product backlog details to be returned using a product backlog query.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogQuery</command:parameterValue> <dev:type> <maml:name>ProductBacklogQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specify the project details to be returned using a project query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Requests</maml:name> <maml:description> <maml:para>Specify the requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SprintBacklogItems</maml:name> <maml:description> <maml:para>Specify the sprint backlog items details to be returned using a sprint backlog item query.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemQuery</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>TimeEntries</maml:name> <maml:description> <maml:para>Specify the time entries details to be returned using a time entry query.</maml:para> </maml:description> <command:parameterValue required="false">TimeEntryQuery</command:parameterValue> <dev:type> <maml:name>TimeEntryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>WorkaroundAttachments</maml:name> <maml:description> <maml:para>Specify the workaround attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Specify the workflow details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProblemQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProblemQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProblemQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the problem query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a problem properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProblemField[]</command:parameterValue> <dev:type> <maml:name>ProblemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProblemView</command:parameterValue> <dev:type> <maml:name>ProblemView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProblemOrderField</command:parameterValue> <dev:type> <maml:name>ProblemOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AgileBoardColumn</maml:name> <maml:description> <maml:para>Specify the agile board column details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>KnowledgeArticle</maml:name> <maml:description> <maml:para>Specify the knowledge article details to be returned using a knowledge article query.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specify the member details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProductBacklog</maml:name> <maml:description> <maml:para>Specify the product backlog details to be returned using a product backlog query.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogQuery</command:parameterValue> <dev:type> <maml:name>ProductBacklogQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specify the project details to be returned using a project query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Requests</maml:name> <maml:description> <maml:para>Specify the requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SprintBacklogItems</maml:name> <maml:description> <maml:para>Specify the sprint backlog items details to be returned using a sprint backlog item query.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemQuery</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>TimeEntries</maml:name> <maml:description> <maml:para>Specify the time entries details to be returned using a time entry query.</maml:para> </maml:description> <command:parameterValue required="false">TimeEntryQuery</command:parameterValue> <dev:type> <maml:name>TimeEntryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>WorkaroundAttachments</maml:name> <maml:description> <maml:para>Specify the workaround attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Specify the workflow details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProblemQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProblemQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProblemQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemField[]</maml:name> </dev:type> <maml:description> <maml:para>The Problem field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemView</maml:name> </dev:type> <maml:description> <maml:para>The problem view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemOrderField</maml:name> </dev:type> <maml:description> <maml:para>The problem order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardColumnQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board column query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleQuery</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteQuery</maml:name> </dev:type> <maml:description> <maml:para>A note query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductBacklogQuery</maml:name> </dev:type> <maml:description> <maml:para>A product backlog query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectQuery</maml:name> </dev:type> <maml:description> <maml:para>A project query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintBacklogItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A sprint backlog item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeEntryQuery</maml:name> </dev:type> <maml:description> <maml:para>A time entry query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ProblemQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A problem query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> <maml:description> <maml:para>A problem query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProblemQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentProblemQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new problem query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProblemQueryFilter cmdlet creates and configures a problem query filter object using the provided parameters. These filters can be used with the New-XurrentProblemQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProblemQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProblemFilter</command:parameterValue> <dev:type> <maml:name>ProblemFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProblemFilter</command:parameterValue> <dev:type> <maml:name>ProblemFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemFilter</maml:name> </dev:type> <maml:description> <maml:para>a problem filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ProblemQuery></maml:name> </dev:type> <maml:description> <maml:para>A problem query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProduct</command:name> <command:verb>New</command:verb> <command:noun>XurrentProduct</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new product.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a product using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProduct</maml:name> <command:parameter required="true" position="0"> <maml:name>Brand</maml:name> <maml:description> <maml:para>The brand name is typically the name of the product's manufacturer.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>The appropriate product category for the product.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the product. Fill out the Brand, Model, Product ID (optional) and Category fields to automatically generate a name based on the values entered in these fields.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>DepreciationMethod</maml:name> <maml:description> <maml:para>Used to specify whether or not configuration items that are based on the product are typically depreciated and if so, which depreciation method is normally applied. Valid values are:• not_depreciated: Not Depreciated• double_declining_balance: Double Declining Balance• reducing_balance: Reducing Balance (or Diminishing Value)• straight_line: Straight Line (or Prime Cost)• sum_of_the_years_digits: Sum of the Year's Digits</maml:para> </maml:description> <command:parameterValue required="false">ProductDepreciationMethod</command:parameterValue> <dev:type> <maml:name>ProductDepreciationMethod</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the product may no longer be used to register new configuration items.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>FinancialOwnerId</maml:name> <maml:description> <maml:para>Identifier of the internal organization which budget is normally used to obtain the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Model</maml:name> <maml:description> <maml:para>The model of the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ProductID</maml:name> <maml:description> <maml:para>The unique identifier of the product that is used by the manufacturer. The concatenation of brand and productID must be unique within a Xurrent account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Rate</maml:name> <maml:description> <maml:para>The yearly rate that should normally be applied to calculate the depreciation of configuration items that are based on the product using the reducing balance (or diminishing value) method.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for maintenance of configuration items created from the product.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceInput</command:parameterValue> <dev:type> <maml:name>RecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the product that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SalvageValue</maml:name> <maml:description> <maml:para>The value of this configuration item at the end of its useful life (i.e. at the end of its depreciation period). When a value is not specified for this field, it is set to zero.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SalvageValueCurrency</maml:name> <maml:description> <maml:para>The currency of the salvage value attributed to this configuration item.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the Service which Service Instances would typically include the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the organization from which the product is typically obtained. If the product is developed internally, select the internal organization that develops it. Note that a lease company should be selected in this field if the product is normally leased.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team responsible for maintaining the product's information in the configuration management database (CMDB).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>UsefulLife</maml:name> <maml:description> <maml:para>The number of years within which configuration items that are based on the product are typically depreciated.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>The person who will be responsible for coordinating the workflows that will be generated automatically in accordance with the recurrence schedule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>WorkflowTemplateId</maml:name> <maml:description> <maml:para>The workflow template that is used to periodically maintain configuration items created from the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="27"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of product properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductField[]</command:parameterValue> <dev:type> <maml:name>ProductField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Brand</maml:name> <maml:description> <maml:para>The brand name is typically the name of the product's manufacturer.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>The appropriate product category for the product.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the product. Fill out the Brand, Model, Product ID (optional) and Category fields to automatically generate a name based on the values entered in these fields.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>DepreciationMethod</maml:name> <maml:description> <maml:para>Used to specify whether or not configuration items that are based on the product are typically depreciated and if so, which depreciation method is normally applied. Valid values are:• not_depreciated: Not Depreciated• double_declining_balance: Double Declining Balance• reducing_balance: Reducing Balance (or Diminishing Value)• straight_line: Straight Line (or Prime Cost)• sum_of_the_years_digits: Sum of the Year's Digits</maml:para> </maml:description> <command:parameterValue required="false">ProductDepreciationMethod</command:parameterValue> <dev:type> <maml:name>ProductDepreciationMethod</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the product may no longer be used to register new configuration items.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>FinancialOwnerId</maml:name> <maml:description> <maml:para>Identifier of the internal organization which budget is normally used to obtain the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Model</maml:name> <maml:description> <maml:para>The model of the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ProductID</maml:name> <maml:description> <maml:para>The unique identifier of the product that is used by the manufacturer. The concatenation of brand and productID must be unique within a Xurrent account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Rate</maml:name> <maml:description> <maml:para>The yearly rate that should normally be applied to calculate the depreciation of configuration items that are based on the product using the reducing balance (or diminishing value) method.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for maintenance of configuration items created from the product.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceInput</command:parameterValue> <dev:type> <maml:name>RecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the product that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SalvageValue</maml:name> <maml:description> <maml:para>The value of this configuration item at the end of its useful life (i.e. at the end of its depreciation period). When a value is not specified for this field, it is set to zero.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SalvageValueCurrency</maml:name> <maml:description> <maml:para>The currency of the salvage value attributed to this configuration item.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the Service which Service Instances would typically include the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the organization from which the product is typically obtained. If the product is developed internally, select the internal organization that develops it. Note that a lease company should be selected in this field if the product is normally leased.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team responsible for maintaining the product's information in the configuration management database (CMDB).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>UsefulLife</maml:name> <maml:description> <maml:para>The number of years within which configuration items that are based on the product are typically depreciated.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>The person who will be responsible for coordinating the workflows that will be generated automatically in accordance with the recurrence schedule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>WorkflowTemplateId</maml:name> <maml:description> <maml:para>The workflow template that is used to periodically maintain configuration items created from the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="27"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of product properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductField[]</command:parameterValue> <dev:type> <maml:name>ProductField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductDepreciationMethod</maml:name> </dev:type> <maml:description> <maml:para>A product depreciation method object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecurrenceInput</maml:name> </dev:type> <maml:description> <maml:para>A recurrence input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductField[]</maml:name> </dev:type> <maml:description> <maml:para>The product field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Product</maml:name> </dev:type> <maml:description> <maml:para>A product object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProductBacklog</command:name> <command:verb>New</command:verb> <command:noun>XurrentProductBacklog</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new product backlog.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a product backlog using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProductBacklog</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the product backlog.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the backlog may not be used to place items on.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ProductOwnerId</maml:name> <maml:description> <maml:para>Identifier of the person responsible for maximizing the value of the work done based on this product backlog.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of product backlog properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductBacklogField[]</command:parameterValue> <dev:type> <maml:name>ProductBacklogField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the product backlog.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the backlog may not be used to place items on.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ProductOwnerId</maml:name> <maml:description> <maml:para>Identifier of the person responsible for maximizing the value of the work done based on this product backlog.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of product backlog properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductBacklogField[]</command:parameterValue> <dev:type> <maml:name>ProductBacklogField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductBacklogField[]</maml:name> </dev:type> <maml:description> <maml:para>The product backlog field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProductBacklog</maml:name> </dev:type> <maml:description> <maml:para>A product backlog object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProductBacklogItemQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProductBacklogItemQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a product backlog item query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProductBacklogItemQuery cmdlet creates and configures a product backlog item query object using the provided parameters. These result can be used with the Invoke-XurrentProductBacklogItemQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProductBacklogItemQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a product backlog item properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductBacklogItemField[]</command:parameterValue> <dev:type> <maml:name>ProductBacklogItemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ProductBacklog</maml:name> <maml:description> <maml:para>Specify the product backlog details to be returned using a product backlog query.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogQuery</command:parameterValue> <dev:type> <maml:name>ProductBacklogQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a product backlog item properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductBacklogItemField[]</command:parameterValue> <dev:type> <maml:name>ProductBacklogItemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ProductBacklog</maml:name> <maml:description> <maml:para>Specify the product backlog details to be returned using a product backlog query.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogQuery</command:parameterValue> <dev:type> <maml:name>ProductBacklogQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductBacklogItemField[]</maml:name> </dev:type> <maml:description> <maml:para>The Product backlog item field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductBacklogQuery</maml:name> </dev:type> <maml:description> <maml:para>A product backlog query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProductBacklogItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A product backlog item query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProductBacklogQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProductBacklogQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a product backlog query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProductBacklogQuery cmdlet creates and configures a product backlog query object using the provided parameters. These result can be used with the Invoke-XurrentProductBacklogQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProductBacklogQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the product backlog query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a product backlog properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductBacklogField[]</command:parameterValue> <dev:type> <maml:name>ProductBacklogField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogView</command:parameterValue> <dev:type> <maml:name>ProductBacklogView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogOrderField</command:parameterValue> <dev:type> <maml:name>ProductBacklogOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Items</maml:name> <maml:description> <maml:para>Specify the items details to be returned using a product backlog item query.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogItemQuery</command:parameterValue> <dev:type> <maml:name>ProductBacklogItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ProductOwner</maml:name> <maml:description> <maml:para>Specify the product owner details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ScrumWorkspaces</maml:name> <maml:description> <maml:para>Specify the scrum workspaces details to be returned using a scrum workspace query.</maml:para> </maml:description> <command:parameterValue required="false">ScrumWorkspaceQuery</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProductBacklogQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProductBacklogQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProductBacklogQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the product backlog query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a product backlog properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductBacklogField[]</command:parameterValue> <dev:type> <maml:name>ProductBacklogField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogView</command:parameterValue> <dev:type> <maml:name>ProductBacklogView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogOrderField</command:parameterValue> <dev:type> <maml:name>ProductBacklogOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Items</maml:name> <maml:description> <maml:para>Specify the items details to be returned using a product backlog item query.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogItemQuery</command:parameterValue> <dev:type> <maml:name>ProductBacklogItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ProductOwner</maml:name> <maml:description> <maml:para>Specify the product owner details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ScrumWorkspaces</maml:name> <maml:description> <maml:para>Specify the scrum workspaces details to be returned using a scrum workspace query.</maml:para> </maml:description> <command:parameterValue required="false">ScrumWorkspaceQuery</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProductBacklogQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProductBacklogQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProductBacklogQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductBacklogField[]</maml:name> </dev:type> <maml:description> <maml:para>The Product backlog field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductBacklogView</maml:name> </dev:type> <maml:description> <maml:para>The product backlog view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductBacklogOrderField</maml:name> </dev:type> <maml:description> <maml:para>The product backlog order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductBacklogItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A product backlog item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ScrumWorkspaceQuery</maml:name> </dev:type> <maml:description> <maml:para>A scrum workspace query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ProductBacklogQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A product backlog query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProductBacklogQuery</maml:name> </dev:type> <maml:description> <maml:para>A product backlog query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProductBacklogQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentProductBacklogQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new product backlog query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProductBacklogQueryFilter cmdlet creates and configures a product backlog query filter object using the provided parameters. These filters can be used with the New-XurrentProductBacklogQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProductBacklogQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProductBacklogFilter</command:parameterValue> <dev:type> <maml:name>ProductBacklogFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProductBacklogFilter</command:parameterValue> <dev:type> <maml:name>ProductBacklogFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductBacklogFilter</maml:name> </dev:type> <maml:description> <maml:para>a product backlog filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ProductBacklogQuery></maml:name> </dev:type> <maml:description> <maml:para>A product backlog query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProductCategory</command:name> <command:verb>New</command:verb> <command:noun>XurrentProductCategory</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new product category.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a product category using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProductCategory</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the product category.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>RuleSet</maml:name> <maml:description> <maml:para>Used to select a set of rules that are to be applied to the products to which the product category is related, as well as the configuration items that are related to those products. The selected rule set dictates which fields are available for these product and configuration items.</maml:para> </maml:description> <command:parameterValue required="true">ProductCategoryRuleSet</command:parameterValue> <dev:type> <maml:name>ProductCategoryRuleSet</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the product category may not be related to any more products.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Group</maml:name> <maml:description> <maml:para>Used to include the product category in a group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of product category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductCategoryField[]</command:parameterValue> <dev:type> <maml:name>ProductCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the product category.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>RuleSet</maml:name> <maml:description> <maml:para>Used to select a set of rules that are to be applied to the products to which the product category is related, as well as the configuration items that are related to those products. The selected rule set dictates which fields are available for these product and configuration items.</maml:para> </maml:description> <command:parameterValue required="true">ProductCategoryRuleSet</command:parameterValue> <dev:type> <maml:name>ProductCategoryRuleSet</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the product category may not be related to any more products.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Group</maml:name> <maml:description> <maml:para>Used to include the product category in a group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of product category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductCategoryField[]</command:parameterValue> <dev:type> <maml:name>ProductCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductCategoryRuleSet</maml:name> </dev:type> <maml:description> <maml:para>A product category rule set object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductCategoryField[]</maml:name> </dev:type> <maml:description> <maml:para>The product category field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProductCategory</maml:name> </dev:type> <maml:description> <maml:para>A product category object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProductCategoryQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProductCategoryQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a product category query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProductCategoryQuery cmdlet creates and configures a product category query object using the provided parameters. These result can be used with the Invoke-XurrentProductCategoryQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProductCategoryQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the product category query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a product category properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductCategoryField[]</command:parameterValue> <dev:type> <maml:name>ProductCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryView</command:parameterValue> <dev:type> <maml:name>ProductCategoryView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryOrderField</command:parameterValue> <dev:type> <maml:name>ProductCategoryOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Products</maml:name> <maml:description> <maml:para>Specify the products details to be returned using a product query.</maml:para> </maml:description> <command:parameterValue required="false">ProductQuery</command:parameterValue> <dev:type> <maml:name>ProductQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProductCategoryQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProductCategoryQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProductCategoryQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the product category query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a product category properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductCategoryField[]</command:parameterValue> <dev:type> <maml:name>ProductCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryView</command:parameterValue> <dev:type> <maml:name>ProductCategoryView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryOrderField</command:parameterValue> <dev:type> <maml:name>ProductCategoryOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Products</maml:name> <maml:description> <maml:para>Specify the products details to be returned using a product query.</maml:para> </maml:description> <command:parameterValue required="false">ProductQuery</command:parameterValue> <dev:type> <maml:name>ProductQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProductCategoryQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProductCategoryQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProductCategoryQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductCategoryField[]</maml:name> </dev:type> <maml:description> <maml:para>The Product category field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductCategoryView</maml:name> </dev:type> <maml:description> <maml:para>The product category view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductCategoryOrderField</maml:name> </dev:type> <maml:description> <maml:para>The product category order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductQuery</maml:name> </dev:type> <maml:description> <maml:para>A product query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ProductCategoryQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A product category query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProductCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A product category query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProductCategoryQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentProductCategoryQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new product category query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProductCategoryQueryFilter cmdlet creates and configures a product category query filter object using the provided parameters. These filters can be used with the New-XurrentProductCategoryQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProductCategoryQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProductCategoryFilter</command:parameterValue> <dev:type> <maml:name>ProductCategoryFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProductCategoryFilter</command:parameterValue> <dev:type> <maml:name>ProductCategoryFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductCategoryFilter</maml:name> </dev:type> <maml:description> <maml:para>a product category filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ProductCategoryQuery></maml:name> </dev:type> <maml:description> <maml:para>A product category query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProductQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProductQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a product query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProductQuery cmdlet creates and configures a product query object using the provided parameters. These result can be used with the Invoke-XurrentProductQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProductQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the product query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a product properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductField[]</command:parameterValue> <dev:type> <maml:name>ProductField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProductView</command:parameterValue> <dev:type> <maml:name>ProductView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProductOrderField</command:parameterValue> <dev:type> <maml:name>ProductOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>FinancialOwner</maml:name> <maml:description> <maml:para>Specify the financial owner details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ProductCategory</maml:name> <maml:description> <maml:para>Specify the product category details to be returned using a product category query.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryQuery</command:parameterValue> <dev:type> <maml:name>ProductCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Specify the recurrence details to be returned using a recurrence template query.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceTemplateQuery</command:parameterValue> <dev:type> <maml:name>RecurrenceTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SupportTeam</maml:name> <maml:description> <maml:para>Specify the support team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>WorkflowManager</maml:name> <maml:description> <maml:para>Specify the workflow manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>WorkflowTemplate</maml:name> <maml:description> <maml:para>Specify the workflow template details to be returned using a workflow template query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProductQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProductQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProductQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the product query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a product properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductField[]</command:parameterValue> <dev:type> <maml:name>ProductField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProductView</command:parameterValue> <dev:type> <maml:name>ProductView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProductOrderField</command:parameterValue> <dev:type> <maml:name>ProductOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>FinancialOwner</maml:name> <maml:description> <maml:para>Specify the financial owner details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ProductCategory</maml:name> <maml:description> <maml:para>Specify the product category details to be returned using a product category query.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryQuery</command:parameterValue> <dev:type> <maml:name>ProductCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Specify the recurrence details to be returned using a recurrence template query.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceTemplateQuery</command:parameterValue> <dev:type> <maml:name>RecurrenceTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SupportTeam</maml:name> <maml:description> <maml:para>Specify the support team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>WorkflowManager</maml:name> <maml:description> <maml:para>Specify the workflow manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>WorkflowTemplate</maml:name> <maml:description> <maml:para>Specify the workflow template details to be returned using a workflow template query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProductQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProductQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProductQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductField[]</maml:name> </dev:type> <maml:description> <maml:para>The Product field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductView</maml:name> </dev:type> <maml:description> <maml:para>The product view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductOrderField</maml:name> </dev:type> <maml:description> <maml:para>The product order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A product category query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecurrenceTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A recurrence template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ProductQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A product query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProductQuery</maml:name> </dev:type> <maml:description> <maml:para>A product query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProductQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentProductQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new product query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProductQueryFilter cmdlet creates and configures a product query filter object using the provided parameters. These filters can be used with the New-XurrentProductQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProductQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProductFilter</command:parameterValue> <dev:type> <maml:name>ProductFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProductFilter</command:parameterValue> <dev:type> <maml:name>ProductFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductFilter</maml:name> </dev:type> <maml:description> <maml:para>a product filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ProductQuery></maml:name> </dev:type> <maml:description> <maml:para>A product query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProject</command:name> <command:verb>New</command:verb> <command:noun>XurrentProject</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new project.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a project using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProject</maml:name> <command:parameter required="true" position="0"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization for which the project is to be implemented.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Justification</maml:name> <maml:description> <maml:para>The reason why the project should be considered for implementation.</maml:para> </maml:description> <command:parameterValue required="true">ProjectJustification</command:parameterValue> <dev:type> <maml:name>ProjectJustification</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the implementation of the project.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the project will be implemented.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the project.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>BudgetAllocated</maml:name> <maml:description> <maml:para>Whether the project has been approved and no longer needs to be considered for funding by portfolio management.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>The appropriate completion reason for the project when it has been completed. It is automatically set to "Complete" when all tasks related to the project have reached the status "Completed", "Approved" or "Canceled".</maml:para> </maml:description> <command:parameterValue required="false">ProjectCompletionReason</command:parameterValue> <dev:type> <maml:name>ProjectCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CostOfEffort</maml:name> <maml:description> <maml:para>The estimated cost of the effort that will be needed from internal employees and/or long-term contractors to implement the project.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CostOfPurchases</maml:name> <maml:description> <maml:para>The estimated cost of all purchases (for equipment, consulting effort, licenses, etc.) needed to implement the project. Recurring costs that will be incurred following the implementation of the project are to be included for the entire ROI calculation period.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Effort</maml:name> <maml:description> <maml:para>The estimated number of hours of effort that will be needed from internal employees and/or long-term contractors to implement the project.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>NewPhases</maml:name> <maml:description> <maml:para>Phases of the project.</maml:para> </maml:description> <command:parameterValue required="false">ProjectPhaseInput[]</command:parameterValue> <dev:type> <maml:name>ProjectPhaseInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Note</maml:name> <maml:description> <maml:para>High-level description of the project. It is also used to add any information that could prove useful for anyone involved in the project, including the people whose approval is needed and the people who are helping to implement it.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProblemIds</maml:name> <maml:description> <maml:para>Identifiers of the problems of the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Program</maml:name> <maml:description> <maml:para>Used to indicate which program the project is a part of.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RequestIds</maml:name> <maml:description> <maml:para>Identifiers of the requests of the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>RiskLevel</maml:name> <maml:description> <maml:para>The risk level of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Status</maml:name> <maml:description> <maml:para>Automatically set based on the status of the project's tasks.</maml:para> </maml:description> <command:parameterValue required="false">ProjectStatus</command:parameterValue> <dev:type> <maml:name>ProjectStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected work hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Value</maml:name> <maml:description> <maml:para>The estimated financial value that the implementation of the project will deliver for the entire ROI calculation period.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>WorkflowIds</maml:name> <maml:description> <maml:para>Identifiers of the workflows of the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>WorkHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the work hours that are to be used to calculate the anticipated assignment and completion target for the tasks of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="28"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectField[]</command:parameterValue> <dev:type> <maml:name>ProjectField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization for which the project is to be implemented.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Justification</maml:name> <maml:description> <maml:para>The reason why the project should be considered for implementation.</maml:para> </maml:description> <command:parameterValue required="true">ProjectJustification</command:parameterValue> <dev:type> <maml:name>ProjectJustification</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the implementation of the project.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the project will be implemented.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the project.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>BudgetAllocated</maml:name> <maml:description> <maml:para>Whether the project has been approved and no longer needs to be considered for funding by portfolio management.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>The appropriate completion reason for the project when it has been completed. It is automatically set to "Complete" when all tasks related to the project have reached the status "Completed", "Approved" or "Canceled".</maml:para> </maml:description> <command:parameterValue required="false">ProjectCompletionReason</command:parameterValue> <dev:type> <maml:name>ProjectCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CostOfEffort</maml:name> <maml:description> <maml:para>The estimated cost of the effort that will be needed from internal employees and/or long-term contractors to implement the project.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CostOfPurchases</maml:name> <maml:description> <maml:para>The estimated cost of all purchases (for equipment, consulting effort, licenses, etc.) needed to implement the project. Recurring costs that will be incurred following the implementation of the project are to be included for the entire ROI calculation period.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Effort</maml:name> <maml:description> <maml:para>The estimated number of hours of effort that will be needed from internal employees and/or long-term contractors to implement the project.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>NewPhases</maml:name> <maml:description> <maml:para>Phases of the project.</maml:para> </maml:description> <command:parameterValue required="false">ProjectPhaseInput[]</command:parameterValue> <dev:type> <maml:name>ProjectPhaseInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Note</maml:name> <maml:description> <maml:para>High-level description of the project. It is also used to add any information that could prove useful for anyone involved in the project, including the people whose approval is needed and the people who are helping to implement it.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProblemIds</maml:name> <maml:description> <maml:para>Identifiers of the problems of the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Program</maml:name> <maml:description> <maml:para>Used to indicate which program the project is a part of.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RequestIds</maml:name> <maml:description> <maml:para>Identifiers of the requests of the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>RiskLevel</maml:name> <maml:description> <maml:para>The risk level of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Status</maml:name> <maml:description> <maml:para>Automatically set based on the status of the project's tasks.</maml:para> </maml:description> <command:parameterValue required="false">ProjectStatus</command:parameterValue> <dev:type> <maml:name>ProjectStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected work hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Value</maml:name> <maml:description> <maml:para>The estimated financial value that the implementation of the project will deliver for the entire ROI calculation period.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>WorkflowIds</maml:name> <maml:description> <maml:para>Identifiers of the workflows of the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>WorkHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the work hours that are to be used to calculate the anticipated assignment and completion target for the tasks of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="28"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectField[]</command:parameterValue> <dev:type> <maml:name>ProjectField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectJustification</maml:name> </dev:type> <maml:description> <maml:para>A project justification object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectCompletionReason</maml:name> </dev:type> <maml:description> <maml:para>A project completion reason object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectPhaseInput[]</maml:name> </dev:type> <maml:description> <maml:para>A project phase input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectStatus</maml:name> </dev:type> <maml:description> <maml:para>A project status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectField[]</maml:name> </dev:type> <maml:description> <maml:para>The project field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Project</maml:name> </dev:type> <maml:description> <maml:para>A project object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectCategory</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectCategory</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new project category.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a project category using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectCategory</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project category. Ideally the name of a project category consists of a single word, such as "Large".</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A very short description of the project category, for example "More than 200 workdays or $200K".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project category may not be related to any more projects.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the project category that might prove useful, especially for project managers when they need to decide which project category to select for a project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the project category takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectCategoryField[]</command:parameterValue> <dev:type> <maml:name>ProjectCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project category. Ideally the name of a project category consists of a single word, such as "Large".</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A very short description of the project category, for example "More than 200 workdays or $200K".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project category may not be related to any more projects.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the project category that might prove useful, especially for project managers when they need to decide which project category to select for a project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the project category takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectCategoryField[]</command:parameterValue> <dev:type> <maml:name>ProjectCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectCategoryField[]</maml:name> </dev:type> <maml:description> <maml:para>The project category field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectCategory</maml:name> </dev:type> <maml:description> <maml:para>A project category object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectCategoryQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectCategoryQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a project category query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectCategoryQuery cmdlet creates and configures a project category query object using the provided parameters. These result can be used with the Invoke-XurrentProjectCategoryQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectCategoryQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the project category query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project category properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectCategoryField[]</command:parameterValue> <dev:type> <maml:name>ProjectCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProjectCategoryQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProjectCategoryQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProjectCategoryQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the project category query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project category properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectCategoryField[]</command:parameterValue> <dev:type> <maml:name>ProjectCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProjectCategoryQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProjectCategoryQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProjectCategoryQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectCategoryField[]</maml:name> </dev:type> <maml:description> <maml:para>The Project category field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ProjectCategoryQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A project category query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A project category query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectCategoryQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectCategoryQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new project category query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectCategoryQueryFilter cmdlet creates and configures a project category query filter object using the provided parameters. These filters can be used with the New-XurrentProjectCategoryQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectCategoryQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProjectCategoryFilter</command:parameterValue> <dev:type> <maml:name>ProjectCategoryFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProjectCategoryFilter</command:parameterValue> <dev:type> <maml:name>ProjectCategoryFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectCategoryFilter</maml:name> </dev:type> <maml:description> <maml:para>a project category filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ProjectCategoryQuery></maml:name> </dev:type> <maml:description> <maml:para>A project category query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectPhaseQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectPhaseQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a project phase query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectPhaseQuery cmdlet creates and configures a project phase query object using the provided parameters. These result can be used with the Invoke-XurrentProjectPhaseQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectPhaseQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project phase properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectPhaseField[]</command:parameterValue> <dev:type> <maml:name>ProjectPhaseField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project phase properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectPhaseField[]</command:parameterValue> <dev:type> <maml:name>ProjectPhaseField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectPhaseField[]</maml:name> </dev:type> <maml:description> <maml:para>The Project phase field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectPhaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A project phase query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a project query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectQuery cmdlet creates and configures a project query object using the provided parameters. These result can be used with the Invoke-XurrentProjectQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the project query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectField[]</command:parameterValue> <dev:type> <maml:name>ProjectField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectView</command:parameterValue> <dev:type> <maml:name>ProjectView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectOrderField</command:parameterValue> <dev:type> <maml:name>ProjectOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Customer</maml:name> <maml:description> <maml:para>Specify the customer details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Invoices</maml:name> <maml:description> <maml:para>Specify the invoices details to be returned using an invoice query.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Phases</maml:name> <maml:description> <maml:para>Specify the phases details to be returned using a project phase query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectPhaseQuery</command:parameterValue> <dev:type> <maml:name>ProjectPhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Problems</maml:name> <maml:description> <maml:para>Specify the problems details to be returned using a problem query.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Requests</maml:name> <maml:description> <maml:para>Specify the requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Risks</maml:name> <maml:description> <maml:para>Specify the risks details to be returned using a risk query.</maml:para> </maml:description> <command:parameterValue required="false">RiskQuery</command:parameterValue> <dev:type> <maml:name>RiskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Tasks</maml:name> <maml:description> <maml:para>Specify the tasks details to be returned using a project task query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Workflows</maml:name> <maml:description> <maml:para>Specify the workflows details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>WorkHours</maml:name> <maml:description> <maml:para>Specify the work hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProjectQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProjectQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProjectQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the project query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectField[]</command:parameterValue> <dev:type> <maml:name>ProjectField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectView</command:parameterValue> <dev:type> <maml:name>ProjectView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectOrderField</command:parameterValue> <dev:type> <maml:name>ProjectOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Customer</maml:name> <maml:description> <maml:para>Specify the customer details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Invoices</maml:name> <maml:description> <maml:para>Specify the invoices details to be returned using an invoice query.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Phases</maml:name> <maml:description> <maml:para>Specify the phases details to be returned using a project phase query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectPhaseQuery</command:parameterValue> <dev:type> <maml:name>ProjectPhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Problems</maml:name> <maml:description> <maml:para>Specify the problems details to be returned using a problem query.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Requests</maml:name> <maml:description> <maml:para>Specify the requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Risks</maml:name> <maml:description> <maml:para>Specify the risks details to be returned using a risk query.</maml:para> </maml:description> <command:parameterValue required="false">RiskQuery</command:parameterValue> <dev:type> <maml:name>RiskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Tasks</maml:name> <maml:description> <maml:para>Specify the tasks details to be returned using a project task query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Workflows</maml:name> <maml:description> <maml:para>Specify the workflows details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>WorkHours</maml:name> <maml:description> <maml:para>Specify the work hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProjectQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProjectQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProjectQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectField[]</maml:name> </dev:type> <maml:description> <maml:para>The Project field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectView</maml:name> </dev:type> <maml:description> <maml:para>The project view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectOrderField</maml:name> </dev:type> <maml:description> <maml:para>The project order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InvoiceQuery</maml:name> </dev:type> <maml:description> <maml:para>An invoice query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteQuery</maml:name> </dev:type> <maml:description> <maml:para>A note query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectPhaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A project phase query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemQuery</maml:name> </dev:type> <maml:description> <maml:para>A problem query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskQuery</maml:name> </dev:type> <maml:description> <maml:para>A risk query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ProjectQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A project query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> <maml:description> <maml:para>A project query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new project query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectQueryFilter cmdlet creates and configures a project query filter object using the provided parameters. These filters can be used with the New-XurrentProjectQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProjectFilter</command:parameterValue> <dev:type> <maml:name>ProjectFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProjectFilter</command:parameterValue> <dev:type> <maml:name>ProjectFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectFilter</maml:name> </dev:type> <maml:description> <maml:para>a project filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ProjectQuery></maml:name> </dev:type> <maml:description> <maml:para>A project query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectRiskLevel</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectRiskLevel</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new project risk level.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a project risk level using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectRiskLevel</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project risk level. Ideally the name of a project risk level consists of a single word, such as "Significant".</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A very short description of the project risk level, for example "Risk of Failure is Significant".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project risk level may not be related to any more projects.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the project risk level that might prove useful, especially for project managers when they need to decide which project risk level to select for a project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the project risk level takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project risk level properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectRiskLevelField[]</command:parameterValue> <dev:type> <maml:name>ProjectRiskLevelField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project risk level. Ideally the name of a project risk level consists of a single word, such as "Significant".</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A very short description of the project risk level, for example "Risk of Failure is Significant".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project risk level may not be related to any more projects.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the project risk level that might prove useful, especially for project managers when they need to decide which project risk level to select for a project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the project risk level takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project risk level properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectRiskLevelField[]</command:parameterValue> <dev:type> <maml:name>ProjectRiskLevelField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectRiskLevelField[]</maml:name> </dev:type> <maml:description> <maml:para>The project risk level field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectRiskLevel</maml:name> </dev:type> <maml:description> <maml:para>A project risk level object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectRiskLevelQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectRiskLevelQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a project risk level query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectRiskLevelQuery cmdlet creates and configures a project risk level query object using the provided parameters. These result can be used with the Invoke-XurrentProjectRiskLevelQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectRiskLevelQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the project risk level query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project risk level properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectRiskLevelField[]</command:parameterValue> <dev:type> <maml:name>ProjectRiskLevelField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProjectRiskLevelQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProjectRiskLevelQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProjectRiskLevelQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the project risk level query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project risk level properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectRiskLevelField[]</command:parameterValue> <dev:type> <maml:name>ProjectRiskLevelField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProjectRiskLevelQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProjectRiskLevelQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProjectRiskLevelQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectRiskLevelField[]</maml:name> </dev:type> <maml:description> <maml:para>The Project risk level field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ProjectRiskLevelQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A project risk level query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectRiskLevelQuery</maml:name> </dev:type> <maml:description> <maml:para>A project risk level query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectRiskLevelQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectRiskLevelQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new project risk level query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectRiskLevelQueryFilter cmdlet creates and configures a project risk level query filter object using the provided parameters. These filters can be used with the New-XurrentProjectRiskLevelQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectRiskLevelQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProjectRiskLevelFilter</command:parameterValue> <dev:type> <maml:name>ProjectRiskLevelFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProjectRiskLevelFilter</command:parameterValue> <dev:type> <maml:name>ProjectRiskLevelFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectRiskLevelFilter</maml:name> </dev:type> <maml:description> <maml:para>a project risk level filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ProjectRiskLevelQuery></maml:name> </dev:type> <maml:description> <maml:para>A project risk level query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectTask</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectTask</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new project task.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a project task using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectTask</maml:name> <command:parameter required="true" position="0"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the project task. Activity tasks are used to assign project-related work to people. Approval tasks are used to collect approvals for projects. Milestones are used to mark specific points along a project's implementation plan.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTaskCategory</command:parameterValue> <dev:type> <maml:name>ProjectTaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PhaseId</maml:name> <maml:description> <maml:para>The identifier of the phase of the project to which the project task belongs.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>The number of minutes it is expected to take for the project task to be completed following its assignment, or following its fixed start date and time if the Start no earlier than field is filled out.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>Identifier of the project this task belongs to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the project task.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AssignedAt</maml:name> <maml:description> <maml:para>Automatically set to the current date and time when the project task is assigned.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Deadline</maml:name> <maml:description> <maml:para>The date and time at which the milestone needs to have been reached.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Used to provide instructions for the person(s) to whom the project task will be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>NewAssignments</maml:name> <maml:description> <maml:para>Assignments of the project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskAssignmentInput[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskAssignmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Note</maml:name> <maml:description> <maml:para>Used to provide information for the person to whom the project task is assigned. It is also used to provide a summary of the actions that have been taken to date and the results of these actions.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design to link to the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>The number of minutes the team is expected to spend working on the project task.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PredecessorIds</maml:name> <maml:description> <maml:para>Identifiers of the predecessors of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number of assignees who need to have provided their approval before the status of the project task gets updated to "Approved".</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SkillPoolId</maml:name> <maml:description> <maml:para>Skill pool that represents the specific expertise needed to complete the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Only used when work on the project task may not start before a specific date and time.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskStatus</command:parameterValue> <dev:type> <maml:name>ProjectTaskStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SuccessorIds</maml:name> <maml:description> <maml:para>Identifiers of the successors of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>The supplier organization that has been asked to assist with the completion of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request to help with the execution of the project task has been registered at the supplier organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>The team to which the project task is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>The project task template that was used to register the project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether the project task is urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the project task is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>When set to true, the completion target of the project task is calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="35"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project task properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the project task. Activity tasks are used to assign project-related work to people. Approval tasks are used to collect approvals for projects. Milestones are used to mark specific points along a project's implementation plan.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTaskCategory</command:parameterValue> <dev:type> <maml:name>ProjectTaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PhaseId</maml:name> <maml:description> <maml:para>The identifier of the phase of the project to which the project task belongs.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>The number of minutes it is expected to take for the project task to be completed following its assignment, or following its fixed start date and time if the Start no earlier than field is filled out.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>Identifier of the project this task belongs to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the project task.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AssignedAt</maml:name> <maml:description> <maml:para>Automatically set to the current date and time when the project task is assigned.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Deadline</maml:name> <maml:description> <maml:para>The date and time at which the milestone needs to have been reached.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Used to provide instructions for the person(s) to whom the project task will be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>NewAssignments</maml:name> <maml:description> <maml:para>Assignments of the project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskAssignmentInput[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskAssignmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Note</maml:name> <maml:description> <maml:para>Used to provide information for the person to whom the project task is assigned. It is also used to provide a summary of the actions that have been taken to date and the results of these actions.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design to link to the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>The number of minutes the team is expected to spend working on the project task.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PredecessorIds</maml:name> <maml:description> <maml:para>Identifiers of the predecessors of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number of assignees who need to have provided their approval before the status of the project task gets updated to "Approved".</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SkillPoolId</maml:name> <maml:description> <maml:para>Skill pool that represents the specific expertise needed to complete the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Only used when work on the project task may not start before a specific date and time.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskStatus</command:parameterValue> <dev:type> <maml:name>ProjectTaskStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SuccessorIds</maml:name> <maml:description> <maml:para>Identifiers of the successors of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>The supplier organization that has been asked to assist with the completion of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request to help with the execution of the project task has been registered at the supplier organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>The team to which the project task is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>The project task template that was used to register the project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether the project task is urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the project task is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>When set to true, the completion target of the project task is calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="35"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project task properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskCategory</maml:name> </dev:type> <maml:description> <maml:para>A project task category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskAssignmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>A project task assignment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskStatus</maml:name> </dev:type> <maml:description> <maml:para>A project task status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskField[]</maml:name> </dev:type> <maml:description> <maml:para>The project task field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTask</maml:name> </dev:type> <maml:description> <maml:para>A project task object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectTaskAssignmentQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectTaskAssignmentQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a project task assignment query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectTaskAssignmentQuery cmdlet creates and configures a project task assignment query object using the provided parameters. These result can be used with the Invoke-XurrentProjectTaskAssignmentQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectTaskAssignmentQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project task assignment properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskAssignmentField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskAssignmentField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Assignee</maml:name> <maml:description> <maml:para>Specify the assignee details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project task assignment properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskAssignmentField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskAssignmentField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Assignee</maml:name> <maml:description> <maml:para>Specify the assignee details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskAssignmentField[]</maml:name> </dev:type> <maml:description> <maml:para>The Project task assignment field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTaskAssignmentQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task assignment query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectTaskQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectTaskQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a project task query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectTaskQuery cmdlet creates and configures a project task query object using the provided parameters. These result can be used with the Invoke-XurrentProjectTaskQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectTaskQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the project task query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project task properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskView</command:parameterValue> <dev:type> <maml:name>ProjectTaskView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskOrderField</command:parameterValue> <dev:type> <maml:name>ProjectTaskOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AgileBoardColumn</maml:name> <maml:description> <maml:para>Specify the agile board column details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Assignments</maml:name> <maml:description> <maml:para>Specify the assignments details to be returned using a project task assignment query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskAssignmentQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskAssignmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PdfDesign</maml:name> <maml:description> <maml:para>Specify the pdf design details to be returned using a pdf design query.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignQuery</command:parameterValue> <dev:type> <maml:name>PdfDesignQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Phase</maml:name> <maml:description> <maml:para>Specify the phase details to be returned using a project phase query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectPhaseQuery</command:parameterValue> <dev:type> <maml:name>ProjectPhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Predecessors</maml:name> <maml:description> <maml:para>Specify the predecessors details to be returned using a project task query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specify the project details to be returned using a project query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SkillPool</maml:name> <maml:description> <maml:para>Specify the skill pool details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SprintBacklogItems</maml:name> <maml:description> <maml:para>Specify the sprint backlog items details to be returned using a sprint backlog item query.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemQuery</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Successors</maml:name> <maml:description> <maml:para>Specify the successors details to be returned using a project task query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specify the template details to be returned using a project task template query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>TimeEntries</maml:name> <maml:description> <maml:para>Specify the time entries details to be returned using a time entry query.</maml:para> </maml:description> <command:parameterValue required="false">TimeEntryQuery</command:parameterValue> <dev:type> <maml:name>TimeEntryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProjectTaskQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProjectTaskQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProjectTaskQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the project task query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project task properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskView</command:parameterValue> <dev:type> <maml:name>ProjectTaskView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskOrderField</command:parameterValue> <dev:type> <maml:name>ProjectTaskOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AgileBoardColumn</maml:name> <maml:description> <maml:para>Specify the agile board column details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Assignments</maml:name> <maml:description> <maml:para>Specify the assignments details to be returned using a project task assignment query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskAssignmentQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskAssignmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PdfDesign</maml:name> <maml:description> <maml:para>Specify the pdf design details to be returned using a pdf design query.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignQuery</command:parameterValue> <dev:type> <maml:name>PdfDesignQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Phase</maml:name> <maml:description> <maml:para>Specify the phase details to be returned using a project phase query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectPhaseQuery</command:parameterValue> <dev:type> <maml:name>ProjectPhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Predecessors</maml:name> <maml:description> <maml:para>Specify the predecessors details to be returned using a project task query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specify the project details to be returned using a project query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SkillPool</maml:name> <maml:description> <maml:para>Specify the skill pool details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SprintBacklogItems</maml:name> <maml:description> <maml:para>Specify the sprint backlog items details to be returned using a sprint backlog item query.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemQuery</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Successors</maml:name> <maml:description> <maml:para>Specify the successors details to be returned using a project task query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specify the template details to be returned using a project task template query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>TimeEntries</maml:name> <maml:description> <maml:para>Specify the time entries details to be returned using a time entry query.</maml:para> </maml:description> <command:parameterValue required="false">TimeEntryQuery</command:parameterValue> <dev:type> <maml:name>TimeEntryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProjectTaskQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProjectTaskQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProjectTaskQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskField[]</maml:name> </dev:type> <maml:description> <maml:para>The Project task field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskView</maml:name> </dev:type> <maml:description> <maml:para>The project task view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskOrderField</maml:name> </dev:type> <maml:description> <maml:para>The project task order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardColumnQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board column query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskAssignmentQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task assignment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteQuery</maml:name> </dev:type> <maml:description> <maml:para>A note query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PdfDesignQuery</maml:name> </dev:type> <maml:description> <maml:para>A pdf design query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectPhaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A project phase query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectQuery</maml:name> </dev:type> <maml:description> <maml:para>A project query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolQuery</maml:name> </dev:type> <maml:description> <maml:para>A skill pool query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintBacklogItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A sprint backlog item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeEntryQuery</maml:name> </dev:type> <maml:description> <maml:para>A time entry query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ProjectTaskQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A project task query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectTaskQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectTaskQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new project task query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectTaskQueryFilter cmdlet creates and configures a project task query filter object using the provided parameters. These filters can be used with the New-XurrentProjectTaskQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectTaskQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTaskFilter</command:parameterValue> <dev:type> <maml:name>ProjectTaskFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTaskFilter</command:parameterValue> <dev:type> <maml:name>ProjectTaskFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskFilter</maml:name> </dev:type> <maml:description> <maml:para>a project task filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ProjectTaskQuery></maml:name> </dev:type> <maml:description> <maml:para>A project task query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectTaskTemplate</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectTaskTemplate</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new project task template.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a project task template using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectTaskTemplate</maml:name> <command:parameter required="true" position="0"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTaskCategory</command:parameterValue> <dev:type> <maml:name>ProjectTaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that should be entered in the Planned duration field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>Identifier of the Agile board column the project task will be placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>Identifier of the Agile board the project task will be placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignToProjectManager</maml:name> <maml:description> <maml:para>Whether the project manager is to be selected in the Assignees field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AssignToRequester</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the person who is selected in the Requested for field of the request for which the project was registered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AssignToRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the business unit to which the organization belongs that is linked to the person who is selected in the Requested for field of the request for which the project was registered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AssignToRequesterManager</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the manager of the project's requester.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>AssignToServiceOwner</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the person who is selected in the Service owner field of the service that is linked to the project that the new project task is a part of.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CopyNotesToProject</maml:name> <maml:description> <maml:para>Whether the Copy note to project box of project tasks that were created based on the template needs to be checked by default. (The Copy notes to project checkbox is called "Copy notes to project by default" when the project task template is in Edit mode.)</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project task template may not be used to help register new project tasks.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a project task created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Instructions field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>NewAssignments</maml:name> <maml:description> <maml:para>Assignments of the project task template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateAssignmentInput[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateAssignmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design that needs to be copied to the PDF design field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the team is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PlannedEffortProjectManager</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the project manager is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PlannedEffortRequester</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the requester is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PlannedEffortRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the requester's business unit manager is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>PlannedEffortRequesterManager</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the requester's manager is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PlannedEffortServiceOwner</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the service owner is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number that needs to be specified in the Required approvals field of a new approval project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SkillPoolId</maml:name> <maml:description> <maml:para>Identifier of the skill pool that should be selected in the Skill pool field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that should be selected in the Supplier field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the Team that should be selected in the Team field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>When set to true, the completion target of project tasks created based on the template are calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="32"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project task template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskTemplateField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTaskCategory</command:parameterValue> <dev:type> <maml:name>ProjectTaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that should be entered in the Planned duration field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>Identifier of the Agile board column the project task will be placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>Identifier of the Agile board the project task will be placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignToProjectManager</maml:name> <maml:description> <maml:para>Whether the project manager is to be selected in the Assignees field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AssignToRequester</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the person who is selected in the Requested for field of the request for which the project was registered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AssignToRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the business unit to which the organization belongs that is linked to the person who is selected in the Requested for field of the request for which the project was registered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AssignToRequesterManager</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the manager of the project's requester.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>AssignToServiceOwner</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the person who is selected in the Service owner field of the service that is linked to the project that the new project task is a part of.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CopyNotesToProject</maml:name> <maml:description> <maml:para>Whether the Copy note to project box of project tasks that were created based on the template needs to be checked by default. (The Copy notes to project checkbox is called "Copy notes to project by default" when the project task template is in Edit mode.)</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project task template may not be used to help register new project tasks.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a project task created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Instructions field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>NewAssignments</maml:name> <maml:description> <maml:para>Assignments of the project task template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateAssignmentInput[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateAssignmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design that needs to be copied to the PDF design field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the team is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PlannedEffortProjectManager</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the project manager is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PlannedEffortRequester</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the requester is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PlannedEffortRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the requester's business unit manager is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>PlannedEffortRequesterManager</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the requester's manager is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PlannedEffortServiceOwner</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the service owner is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number that needs to be specified in the Required approvals field of a new approval project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SkillPoolId</maml:name> <maml:description> <maml:para>Identifier of the skill pool that should be selected in the Skill pool field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that should be selected in the Supplier field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the Team that should be selected in the Team field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>When set to true, the completion target of project tasks created based on the template are calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="32"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project task template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskTemplateField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskCategory</maml:name> </dev:type> <maml:description> <maml:para>A project task category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateAssignmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>A project task template assignment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The project task template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTaskTemplate</maml:name> </dev:type> <maml:description> <maml:para>A project task template object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectTaskTemplateAssignmentQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectTaskTemplateAssignmentQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a project task template assignment query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectTaskTemplateAssignmentQuery cmdlet creates and configures a project task template assignment query object using the provided parameters. These result can be used with the Invoke-XurrentProjectTaskTemplateAssignmentQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectTaskTemplateAssignmentQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project task template assignment properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskTemplateAssignmentField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateAssignmentField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Assignee</maml:name> <maml:description> <maml:para>Specify the assignee details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project task template assignment properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskTemplateAssignmentField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateAssignmentField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Assignee</maml:name> <maml:description> <maml:para>Specify the assignee details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateAssignmentField[]</maml:name> </dev:type> <maml:description> <maml:para>The Project task template assignment field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTaskTemplateAssignmentQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task template assignment query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectTaskTemplateQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectTaskTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a project task template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectTaskTemplateQuery cmdlet creates and configures a project task template query object using the provided parameters. These result can be used with the Invoke-XurrentProjectTaskTemplateQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectTaskTemplateQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the project task template query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project task template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskTemplateField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateView</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateOrderField</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AgileBoardColumn</maml:name> <maml:description> <maml:para>Specify the agile board column details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Assignments</maml:name> <maml:description> <maml:para>Specify the assignments details to be returned using a project task template assignment query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateAssignmentQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateAssignmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>Specify the note attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PdfDesign</maml:name> <maml:description> <maml:para>Specify the pdf design details to be returned using a pdf design query.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignQuery</command:parameterValue> <dev:type> <maml:name>PdfDesignQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ProjectTemplates</maml:name> <maml:description> <maml:para>Specify the project templates details to be returned using a project template query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplateQuery</command:parameterValue> <dev:type> <maml:name>ProjectTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SkillPool</maml:name> <maml:description> <maml:para>Specify the skill pool details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Tasks</maml:name> <maml:description> <maml:para>Specify the tasks details to be returned using a project task query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProjectTaskTemplateQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProjectTaskTemplateQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProjectTaskTemplateQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the project task template query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project task template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskTemplateField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateView</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateOrderField</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AgileBoardColumn</maml:name> <maml:description> <maml:para>Specify the agile board column details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Assignments</maml:name> <maml:description> <maml:para>Specify the assignments details to be returned using a project task template assignment query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateAssignmentQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateAssignmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>Specify the note attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PdfDesign</maml:name> <maml:description> <maml:para>Specify the pdf design details to be returned using a pdf design query.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignQuery</command:parameterValue> <dev:type> <maml:name>PdfDesignQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ProjectTemplates</maml:name> <maml:description> <maml:para>Specify the project templates details to be returned using a project template query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplateQuery</command:parameterValue> <dev:type> <maml:name>ProjectTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SkillPool</maml:name> <maml:description> <maml:para>Specify the skill pool details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Tasks</maml:name> <maml:description> <maml:para>Specify the tasks details to be returned using a project task query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProjectTaskTemplateQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProjectTaskTemplateQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProjectTaskTemplateQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The Project task template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateView</maml:name> </dev:type> <maml:description> <maml:para>The project task template view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateOrderField</maml:name> </dev:type> <maml:description> <maml:para>The project task template order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardColumnQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board column query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateAssignmentQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task template assignment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PdfDesignQuery</maml:name> </dev:type> <maml:description> <maml:para>A pdf design query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A project template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolQuery</maml:name> </dev:type> <maml:description> <maml:para>A skill pool query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ProjectTaskTemplateQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A project task template query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTaskTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task template query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectTaskTemplateQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectTaskTemplateQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new project task template query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectTaskTemplateQueryFilter cmdlet creates and configures a project task template query filter object using the provided parameters. These filters can be used with the New-XurrentProjectTaskTemplateQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectTaskTemplateQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTaskTemplateFilter</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTaskTemplateFilter</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateFilter</maml:name> </dev:type> <maml:description> <maml:para>a project task template filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ProjectTaskTemplateQuery></maml:name> </dev:type> <maml:description> <maml:para>A project task template query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectTaskTemplateRelationQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectTaskTemplateRelationQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a project task template relation query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectTaskTemplateRelationQuery cmdlet creates and configures a project task template relation query object using the provided parameters. These result can be used with the Invoke-XurrentProjectTaskTemplateRelationQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectTaskTemplateRelationQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project task template relation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskTemplateRelationField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateRelationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Phase</maml:name> <maml:description> <maml:para>Specify the phase details to be returned using a project template phase query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplatePhaseQuery</command:parameterValue> <dev:type> <maml:name>ProjectTemplatePhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>TaskTemplate</maml:name> <maml:description> <maml:para>Specify the task template details to be returned using a project task template query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project task template relation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskTemplateRelationField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateRelationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Phase</maml:name> <maml:description> <maml:para>Specify the phase details to be returned using a project template phase query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplatePhaseQuery</command:parameterValue> <dev:type> <maml:name>ProjectTemplatePhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>TaskTemplate</maml:name> <maml:description> <maml:para>Specify the task template details to be returned using a project task template query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateRelationField[]</maml:name> </dev:type> <maml:description> <maml:para>The Project task template relation field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTemplatePhaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A project template phase query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task template query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTaskTemplateRelationQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task template relation query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectTemplate</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectTemplate</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new project template.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a project template using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectTemplate</maml:name> <command:parameter required="true" position="0"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new project when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project template may not be used to help register new projects.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>NewPhases</maml:name> <maml:description> <maml:para>Phases of the project template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectPhaseInput[]</command:parameterValue> <dev:type> <maml:name>ProjectPhaseInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewTaskTemplateRelations</maml:name> <maml:description> <maml:para>Project task template relations of the project template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplateTaskTemplateInput[]</command:parameterValue> <dev:type> <maml:name>ProjectTemplateTaskTemplateInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="7"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTemplateField[]</command:parameterValue> <dev:type> <maml:name>ProjectTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new project when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project template may not be used to help register new projects.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>NewPhases</maml:name> <maml:description> <maml:para>Phases of the project template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectPhaseInput[]</command:parameterValue> <dev:type> <maml:name>ProjectPhaseInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewTaskTemplateRelations</maml:name> <maml:description> <maml:para>Project task template relations of the project template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplateTaskTemplateInput[]</command:parameterValue> <dev:type> <maml:name>ProjectTemplateTaskTemplateInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="7"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTemplateField[]</command:parameterValue> <dev:type> <maml:name>ProjectTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectPhaseInput[]</maml:name> </dev:type> <maml:description> <maml:para>A project phase input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTemplateTaskTemplateInput[]</maml:name> </dev:type> <maml:description> <maml:para>A project template task template input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The project template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTemplate</maml:name> </dev:type> <maml:description> <maml:para>A project template object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectTemplatePhaseQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectTemplatePhaseQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a project template phase query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectTemplatePhaseQuery cmdlet creates and configures a project template phase query object using the provided parameters. These result can be used with the Invoke-XurrentProjectTemplatePhaseQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectTemplatePhaseQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project template phase properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTemplatePhaseField[]</command:parameterValue> <dev:type> <maml:name>ProjectTemplatePhaseField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project template phase properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTemplatePhaseField[]</command:parameterValue> <dev:type> <maml:name>ProjectTemplatePhaseField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTemplatePhaseField[]</maml:name> </dev:type> <maml:description> <maml:para>The Project template phase field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTemplatePhaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A project template phase query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectTemplateQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a project template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectTemplateQuery cmdlet creates and configures a project template query object using the provided parameters. These result can be used with the Invoke-XurrentProjectTemplateQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectTemplateQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the project template query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTemplateField[]</command:parameterValue> <dev:type> <maml:name>ProjectTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplateView</command:parameterValue> <dev:type> <maml:name>ProjectTemplateView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplateOrderField</command:parameterValue> <dev:type> <maml:name>ProjectTemplateOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Phases</maml:name> <maml:description> <maml:para>Specify the phases details to be returned using a project template phase query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplatePhaseQuery</command:parameterValue> <dev:type> <maml:name>ProjectTemplatePhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>TaskTemplateRelations</maml:name> <maml:description> <maml:para>Specify the task template relations details to be returned using a project task template relation query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateRelationQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateRelationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProjectTemplateQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProjectTemplateQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProjectTemplateQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the project template query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a project template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTemplateField[]</command:parameterValue> <dev:type> <maml:name>ProjectTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplateView</command:parameterValue> <dev:type> <maml:name>ProjectTemplateView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplateOrderField</command:parameterValue> <dev:type> <maml:name>ProjectTemplateOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Phases</maml:name> <maml:description> <maml:para>Specify the phases details to be returned using a project template phase query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplatePhaseQuery</command:parameterValue> <dev:type> <maml:name>ProjectTemplatePhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>TaskTemplateRelations</maml:name> <maml:description> <maml:para>Specify the task template relations details to be returned using a project task template relation query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateRelationQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateRelationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ProjectTemplateQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ProjectTemplateQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ProjectTemplateQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The Project template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTemplateView</maml:name> </dev:type> <maml:description> <maml:para>The project template view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTemplateOrderField</maml:name> </dev:type> <maml:description> <maml:para>The project template order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTemplatePhaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A project template phase query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateRelationQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task template relation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ProjectTemplateQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A project template query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A project template query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProjectTemplateQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentProjectTemplateQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new project template query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProjectTemplateQueryFilter cmdlet creates and configures a project template query filter object using the provided parameters. These filters can be used with the New-XurrentProjectTemplateQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProjectTemplateQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTemplateFilter</command:parameterValue> <dev:type> <maml:name>ProjectTemplateFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ProjectTemplateFilter</command:parameterValue> <dev:type> <maml:name>ProjectTemplateFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTemplateFilter</maml:name> </dev:type> <maml:description> <maml:para>a project template filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ProjectTemplateQuery></maml:name> </dev:type> <maml:description> <maml:para>A project template query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProviderShopArticleQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProviderShopArticleQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a provider shop article query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProviderShopArticleQuery cmdlet creates and configures a provider shop article query object using the provided parameters. These result can be used with the Invoke-XurrentProviderShopArticleQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProviderShopArticleQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a provider shop article properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProviderShopArticleField[]</command:parameterValue> <dev:type> <maml:name>ProviderShopArticleField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a provider shop article properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProviderShopArticleField[]</command:parameterValue> <dev:type> <maml:name>ProviderShopArticleField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProviderShopArticleField[]</maml:name> </dev:type> <maml:description> <maml:para>The Provider shop article field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProviderShopArticleQuery</maml:name> </dev:type> <maml:description> <maml:para>A provider shop article query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentProviderShopOrderLineQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentProviderShopOrderLineQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a provider shop order line query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentProviderShopOrderLineQuery cmdlet creates and configures a provider shop order line query object using the provided parameters. These result can be used with the Invoke-XurrentProviderShopOrderLineQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentProviderShopOrderLineQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a provider shop order line properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProviderShopOrderLineField[]</command:parameterValue> <dev:type> <maml:name>ProviderShopOrderLineField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a provider shop order line properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProviderShopOrderLineField[]</command:parameterValue> <dev:type> <maml:name>ProviderShopOrderLineField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProviderShopOrderLineField[]</maml:name> </dev:type> <maml:description> <maml:para>The Provider shop order line field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProviderShopOrderLineQuery</maml:name> </dev:type> <maml:description> <maml:para>A provider shop order line query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRateLimitQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentRateLimitQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a rate limit query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentRateLimitQuery cmdlet creates and configures a rate limit query object using the provided parameters. These result can be used with the Invoke-XurrentRateLimitQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRateLimitQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a rate limit properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RateLimitField[]</command:parameterValue> <dev:type> <maml:name>RateLimitField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a rate limit properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RateLimitField[]</command:parameterValue> <dev:type> <maml:name>RateLimitField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RateLimitField[]</maml:name> </dev:type> <maml:description> <maml:para>The Rate limit field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RateLimitQuery</maml:name> </dev:type> <maml:description> <maml:para>A rate limit query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRecordQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentRecordQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a record query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentRecordQuery cmdlet creates and configures a record query object using the provided parameters. These result can be used with the Invoke-XurrentRecordQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRecordQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a record properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RecordField[]</command:parameterValue> <dev:type> <maml:name>RecordField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a record properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RecordField[]</command:parameterValue> <dev:type> <maml:name>RecordField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecordField[]</maml:name> </dev:type> <maml:description> <maml:para>The Record field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RecordQuery</maml:name> </dev:type> <maml:description> <maml:para>A record query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRecurrenceQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentRecurrenceQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a recurrence query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentRecurrenceQuery cmdlet creates and configures a recurrence query object using the provided parameters. These result can be used with the Invoke-XurrentRecurrenceQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRecurrenceQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a recurrence properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RecurrenceField[]</command:parameterValue> <dev:type> <maml:name>RecurrenceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Calendar</maml:name> <maml:description> <maml:para>Specify the calendar details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a recurrence properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RecurrenceField[]</command:parameterValue> <dev:type> <maml:name>RecurrenceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Calendar</maml:name> <maml:description> <maml:para>Specify the calendar details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecurrenceField[]</maml:name> </dev:type> <maml:description> <maml:para>The Recurrence field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RecurrenceQuery</maml:name> </dev:type> <maml:description> <maml:para>A recurrence query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRecurrenceTemplateQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentRecurrenceTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a recurrence template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentRecurrenceTemplateQuery cmdlet creates and configures a recurrence template query object using the provided parameters. These result can be used with the Invoke-XurrentRecurrenceTemplateQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRecurrenceTemplateQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a recurrence template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RecurrenceTemplateField[]</command:parameterValue> <dev:type> <maml:name>RecurrenceTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Calendar</maml:name> <maml:description> <maml:para>Specify the calendar details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a recurrence template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RecurrenceTemplateField[]</command:parameterValue> <dev:type> <maml:name>RecurrenceTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Calendar</maml:name> <maml:description> <maml:para>Specify the calendar details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecurrenceTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The Recurrence template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RecurrenceTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A recurrence template query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRelease</command:name> <command:verb>New</command:verb> <command:noun>XurrentRelease</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new release.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a release using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRelease</maml:name> <command:parameter required="true" position="0"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the implementation of the release. The person must have the release Manager role.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the release.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Note</maml:name> <maml:description> <maml:para>High-level description of the result that should be accomplished by the implementation of the release's workflows. It is also used to add any information that could prove useful for anyone affected by the release.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>WorkflowIds</maml:name> <maml:description> <maml:para>Identifiers of the workflows of the release.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of release properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReleaseField[]</command:parameterValue> <dev:type> <maml:name>ReleaseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the implementation of the release. The person must have the release Manager role.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the release.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Note</maml:name> <maml:description> <maml:para>High-level description of the result that should be accomplished by the implementation of the release's workflows. It is also used to add any information that could prove useful for anyone affected by the release.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>WorkflowIds</maml:name> <maml:description> <maml:para>Identifiers of the workflows of the release.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of release properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReleaseField[]</command:parameterValue> <dev:type> <maml:name>ReleaseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReleaseField[]</maml:name> </dev:type> <maml:description> <maml:para>The release field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Release</maml:name> </dev:type> <maml:description> <maml:para>A release object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentReleaseQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentReleaseQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a release query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentReleaseQuery cmdlet creates and configures a release query object using the provided parameters. These result can be used with the Invoke-XurrentReleaseQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentReleaseQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the release query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a release properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReleaseField[]</command:parameterValue> <dev:type> <maml:name>ReleaseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ReleaseView</command:parameterValue> <dev:type> <maml:name>ReleaseView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ReleaseOrderField</command:parameterValue> <dev:type> <maml:name>ReleaseOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Workflows</maml:name> <maml:description> <maml:para>Specify the workflows details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ReleaseQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ReleaseQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ReleaseQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the release query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a release properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReleaseField[]</command:parameterValue> <dev:type> <maml:name>ReleaseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ReleaseView</command:parameterValue> <dev:type> <maml:name>ReleaseView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ReleaseOrderField</command:parameterValue> <dev:type> <maml:name>ReleaseOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Workflows</maml:name> <maml:description> <maml:para>Specify the workflows details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ReleaseQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ReleaseQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ReleaseQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReleaseField[]</maml:name> </dev:type> <maml:description> <maml:para>The Release field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReleaseView</maml:name> </dev:type> <maml:description> <maml:para>The release view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReleaseOrderField</maml:name> </dev:type> <maml:description> <maml:para>The release order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteQuery</maml:name> </dev:type> <maml:description> <maml:para>A note query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ReleaseQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A release query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ReleaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A release query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentReleaseQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentReleaseQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new release query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentReleaseQueryFilter cmdlet creates and configures a release query filter object using the provided parameters. These filters can be used with the New-XurrentReleaseQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentReleaseQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ReleaseFilter</command:parameterValue> <dev:type> <maml:name>ReleaseFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ReleaseFilter</command:parameterValue> <dev:type> <maml:name>ReleaseFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReleaseFilter</maml:name> </dev:type> <maml:description> <maml:para>a release filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ReleaseQuery></maml:name> </dev:type> <maml:description> <maml:para>A release query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRequest</command:name> <command:verb>New</command:verb> <command:noun>XurrentRequest</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new request.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a request using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRequest</maml:name> <command:parameter required="false" position="0"> <maml:name>Addressed</maml:name> <maml:description> <maml:para>Default: false - When the Satisfaction field of the request is set to 'Dissatisfied', a person who has the Service Desk Manager role, can check the Addressed box to indicate that the requester has been conciliated.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Category</maml:name> <maml:description> <maml:para>The Category field is used to select the category of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestCategory</command:parameterValue> <dev:type> <maml:name>RequestCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>The appropriate completion reason for the request when it has been completed.</maml:para> </maml:description> <command:parameterValue required="false">RequestCompletionReason</command:parameterValue> <dev:type> <maml:name>RequestCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items to relate to the request. When this field is used to update an existing request, all configuration items that were linked to this request will be replaced by the supplied configuration items.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>DesiredCompletionAt</maml:name> <maml:description> <maml:para>The date and time that has been agreed on for the completion of the request. The desired completion overwrites the automatically calculated resolution target of any affected SLA that is related to the request when the desired completion is later than the affected SLA's resolution target. By default, the person selected in the Requested by field receives a notification based on the 'Desired Completion Set for Request' email template whenever the value in the Desired completion field is set, updated or removed.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>DowntimeEndAt</maml:name> <maml:description> <maml:para>Used to specify the actual date and time at which the service became available again.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>DowntimeStartAt</maml:name> <maml:description> <maml:para>Used to specify the actual date and time at which the service outage started.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>GroupedIntoId</maml:name> <maml:description> <maml:para>ID of the request group that is used to group the requests that have been submitted for the resolution of exactly the same incident, for the implementation of exactly the same change, for the provision of exactly the same information, etc.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Impact</maml:name> <maml:description> <maml:para>Used to select the extent to which the service instance is impacted.</maml:para> </maml:description> <command:parameterValue required="false">RequestImpact</command:parameterValue> <dev:type> <maml:name>RequestImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>InternalNote</maml:name> <maml:description> <maml:para>Used to provide information that is visible only for people who have the Auditor, Specialist or Account Administrator role of the account for which the internal note is intended. The x-xurrent-account header sent determines the account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>InternalNoteAttachments</maml:name> <maml:description> <maml:para>The attachments used in the internalNote field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>KnowledgeArticleIds</maml:name> <maml:description> <maml:para>Knowledge articles applied to the request.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>MajorIncidentStatus</maml:name> <maml:description> <maml:para>Used to indicate the status in the major incident management process.</maml:para> </maml:description> <command:parameterValue required="false">RequestMajorIncidentStatus</command:parameterValue> <dev:type> <maml:name>RequestMajorIncidentStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>ID of the person to whom the request is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>NewTags</maml:name> <maml:description> <maml:para>Tags to be added to the request.</maml:para> </maml:description> <command:parameterValue required="false">TagInput[]</command:parameterValue> <dev:type> <maml:name>TagInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>NewWatches</maml:name> <maml:description> <maml:para>New or updated watches.</maml:para> </maml:description> <command:parameterValue required="false">WatchInput[]</command:parameterValue> <dev:type> <maml:name>WatchInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Note</maml:name> <maml:description> <maml:para>Any additional information that could prove useful for resolving the request and/or to provide a summary of the actions that have been taken since the last entry.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>The attachments used in the note field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>ProblemId</maml:name> <maml:description> <maml:para>ID of problem to link request to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>ProductBacklogEstimate</maml:name> <maml:description> <maml:para>Estimate of the relative size of this item on the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>ProductBacklogId</maml:name> <maml:description> <maml:para>Identifier of the product backlog this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>ProductBacklogPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item on the backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>ID of project to link request to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>ProviderNotAccountable</maml:name> <maml:description> <maml:para>Default: false - Whether the provider currently indicates not to be accountable.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>RequestedById</maml:name> <maml:description> <maml:para>ID of the person who submitted the request. Defaults to the Requested for field if its value was explicitely provided, otherwise it defaults to the current authenticated person</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>RequestedForId</maml:name> <maml:description> <maml:para>ID of the person for whom the request was submitted. The person selected in the Requested by field is automatically selected in this field, but another person can be selected if the request is submitted for another person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Reviewed</maml:name> <maml:description> <maml:para>Default: false - A request can be marked as reviewed by the problem manager of the service of the service instance that is linked to the request. Marking a request as reviewed excludes it from the 'Requests for Problem Identification' view.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>ID of the service instance in which the cause of the incident resides, for which the change is requested, or about which information is needed.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>Status</maml:name> <maml:description> <maml:para>Default: assigned - Used to select the current status of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestStatus</command:parameterValue> <dev:type> <maml:name>RequestStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>ID of the supplier organization that has been asked to assist with the request. The supplier organization is automatically selected in this field after a service instance has been selected that is provided by an external service provider organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request has been registered at the supplier organization. If the supplier provided a link to the request, enter the entire URL in this field.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>SupportDomain</maml:name> <maml:description> <maml:para>Used to specify the support domain account ID in which the request is to be registered. This parameter needs to be specified when the current user's Person record is registered in a directory account. The ID of a Xurrent account can be found in the 'Account Overview' section of the Settings console.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>ID of the team to which the request is to be assigned. By default, the first line team of the service instance that is related to the request will be selected. If a first line team has not been specified for the service instance, the support team of the service instance will be selected instead.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>ID of the request template to apply to the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Setting to true marks request as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="46"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the request is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="47"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>ID of workflow to link request to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="48"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of request properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RequestField[]</command:parameterValue> <dev:type> <maml:name>RequestField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="49"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>Addressed</maml:name> <maml:description> <maml:para>Default: false - When the Satisfaction field of the request is set to 'Dissatisfied', a person who has the Service Desk Manager role, can check the Addressed box to indicate that the requester has been conciliated.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Category</maml:name> <maml:description> <maml:para>The Category field is used to select the category of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestCategory</command:parameterValue> <dev:type> <maml:name>RequestCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>The appropriate completion reason for the request when it has been completed.</maml:para> </maml:description> <command:parameterValue required="false">RequestCompletionReason</command:parameterValue> <dev:type> <maml:name>RequestCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items to relate to the request. When this field is used to update an existing request, all configuration items that were linked to this request will be replaced by the supplied configuration items.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>DesiredCompletionAt</maml:name> <maml:description> <maml:para>The date and time that has been agreed on for the completion of the request. The desired completion overwrites the automatically calculated resolution target of any affected SLA that is related to the request when the desired completion is later than the affected SLA's resolution target. By default, the person selected in the Requested by field receives a notification based on the 'Desired Completion Set for Request' email template whenever the value in the Desired completion field is set, updated or removed.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>DowntimeEndAt</maml:name> <maml:description> <maml:para>Used to specify the actual date and time at which the service became available again.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>DowntimeStartAt</maml:name> <maml:description> <maml:para>Used to specify the actual date and time at which the service outage started.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>GroupedIntoId</maml:name> <maml:description> <maml:para>ID of the request group that is used to group the requests that have been submitted for the resolution of exactly the same incident, for the implementation of exactly the same change, for the provision of exactly the same information, etc.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Impact</maml:name> <maml:description> <maml:para>Used to select the extent to which the service instance is impacted.</maml:para> </maml:description> <command:parameterValue required="false">RequestImpact</command:parameterValue> <dev:type> <maml:name>RequestImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>InternalNote</maml:name> <maml:description> <maml:para>Used to provide information that is visible only for people who have the Auditor, Specialist or Account Administrator role of the account for which the internal note is intended. The x-xurrent-account header sent determines the account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>InternalNoteAttachments</maml:name> <maml:description> <maml:para>The attachments used in the internalNote field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>KnowledgeArticleIds</maml:name> <maml:description> <maml:para>Knowledge articles applied to the request.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>MajorIncidentStatus</maml:name> <maml:description> <maml:para>Used to indicate the status in the major incident management process.</maml:para> </maml:description> <command:parameterValue required="false">RequestMajorIncidentStatus</command:parameterValue> <dev:type> <maml:name>RequestMajorIncidentStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>ID of the person to whom the request is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>NewTags</maml:name> <maml:description> <maml:para>Tags to be added to the request.</maml:para> </maml:description> <command:parameterValue required="false">TagInput[]</command:parameterValue> <dev:type> <maml:name>TagInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>NewWatches</maml:name> <maml:description> <maml:para>New or updated watches.</maml:para> </maml:description> <command:parameterValue required="false">WatchInput[]</command:parameterValue> <dev:type> <maml:name>WatchInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Note</maml:name> <maml:description> <maml:para>Any additional information that could prove useful for resolving the request and/or to provide a summary of the actions that have been taken since the last entry.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>The attachments used in the note field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>ProblemId</maml:name> <maml:description> <maml:para>ID of problem to link request to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>ProductBacklogEstimate</maml:name> <maml:description> <maml:para>Estimate of the relative size of this item on the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>ProductBacklogId</maml:name> <maml:description> <maml:para>Identifier of the product backlog this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>ProductBacklogPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item on the backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>ID of project to link request to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>ProviderNotAccountable</maml:name> <maml:description> <maml:para>Default: false - Whether the provider currently indicates not to be accountable.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>RequestedById</maml:name> <maml:description> <maml:para>ID of the person who submitted the request. Defaults to the Requested for field if its value was explicitely provided, otherwise it defaults to the current authenticated person</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>RequestedForId</maml:name> <maml:description> <maml:para>ID of the person for whom the request was submitted. The person selected in the Requested by field is automatically selected in this field, but another person can be selected if the request is submitted for another person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Reviewed</maml:name> <maml:description> <maml:para>Default: false - A request can be marked as reviewed by the problem manager of the service of the service instance that is linked to the request. Marking a request as reviewed excludes it from the 'Requests for Problem Identification' view.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>ID of the service instance in which the cause of the incident resides, for which the change is requested, or about which information is needed.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>Status</maml:name> <maml:description> <maml:para>Default: assigned - Used to select the current status of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestStatus</command:parameterValue> <dev:type> <maml:name>RequestStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>ID of the supplier organization that has been asked to assist with the request. The supplier organization is automatically selected in this field after a service instance has been selected that is provided by an external service provider organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request has been registered at the supplier organization. If the supplier provided a link to the request, enter the entire URL in this field.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>SupportDomain</maml:name> <maml:description> <maml:para>Used to specify the support domain account ID in which the request is to be registered. This parameter needs to be specified when the current user's Person record is registered in a directory account. The ID of a Xurrent account can be found in the 'Account Overview' section of the Settings console.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>ID of the team to which the request is to be assigned. By default, the first line team of the service instance that is related to the request will be selected. If a first line team has not been specified for the service instance, the support team of the service instance will be selected instead.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>ID of the request template to apply to the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Setting to true marks request as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="46"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the request is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="47"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>ID of workflow to link request to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="48"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of request properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RequestField[]</command:parameterValue> <dev:type> <maml:name>RequestField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="49"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestCategory</maml:name> </dev:type> <maml:description> <maml:para>A request category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestCompletionReason</maml:name> </dev:type> <maml:description> <maml:para>A request completion reason object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestImpact</maml:name> </dev:type> <maml:description> <maml:para>A request impact object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestMajorIncidentStatus</maml:name> </dev:type> <maml:description> <maml:para>A request major incident status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TagInput[]</maml:name> </dev:type> <maml:description> <maml:para>A tag input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WatchInput[]</maml:name> </dev:type> <maml:description> <maml:para>A watch input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestStatus</maml:name> </dev:type> <maml:description> <maml:para>A request status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestField[]</maml:name> </dev:type> <maml:description> <maml:para>The request field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Request</maml:name> </dev:type> <maml:description> <maml:para>A request object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRequestQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentRequestQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a request query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentRequestQuery cmdlet creates and configures a request query object using the provided parameters. These result can be used with the Invoke-XurrentRequestQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRequestQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the request query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a request properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RequestField[]</command:parameterValue> <dev:type> <maml:name>RequestField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">RequestView</command:parameterValue> <dev:type> <maml:name>RequestView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">RequestOrderField</command:parameterValue> <dev:type> <maml:name>RequestOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AffectedSlas</maml:name> <maml:description> <maml:para>Specify the affected SLAs details to be returned using an affected service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">AffectedSlaQuery</command:parameterValue> <dev:type> <maml:name>AffectedSlaQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>AgileBoardColumn</maml:name> <maml:description> <maml:para>Specify the agile board column details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Specify the created by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Feedback</maml:name> <maml:description> <maml:para>Specify the feedback details to be returned using a feedback query.</maml:para> </maml:description> <command:parameterValue required="false">FeedbackQuery</command:parameterValue> <dev:type> <maml:name>FeedbackQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>FeedbackOnKnowledgeArticle</maml:name> <maml:description> <maml:para>Specify the feedback on knowledge article details to be returned using a knowledge article query.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>GroupedInto</maml:name> <maml:description> <maml:para>Specify the grouped into details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>GroupedRequests</maml:name> <maml:description> <maml:para>Specify the grouped requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>KnowledgeArticles</maml:name> <maml:description> <maml:para>Specify the knowledge articles details to be returned using a knowledge article query.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specify the member details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Specify the organization details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Problem</maml:name> <maml:description> <maml:para>Specify the problem details to be returned using a problem query.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>ProductBacklog</maml:name> <maml:description> <maml:para>Specify the product backlog details to be returned using a product backlog query.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogQuery</command:parameterValue> <dev:type> <maml:name>ProductBacklogQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specify the project details to be returned using a project query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>RequestedBy</maml:name> <maml:description> <maml:para>Specify the requested by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>RequestedFor</maml:name> <maml:description> <maml:para>Specify the requested for details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>SprintBacklogItems</maml:name> <maml:description> <maml:para>Specify the sprint backlog items details to be returned using a sprint backlog item query.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemQuery</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify the tags details to be returned using a tag query.</maml:para> </maml:description> <command:parameterValue required="false">TagQuery</command:parameterValue> <dev:type> <maml:name>TagQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Task</maml:name> <maml:description> <maml:para>Specify the task details to be returned using a task query.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specify the template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>TimeEntries</maml:name> <maml:description> <maml:para>Specify the time entries details to be returned using a time entry query.</maml:para> </maml:description> <command:parameterValue required="false">TimeEntryQuery</command:parameterValue> <dev:type> <maml:name>TimeEntryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>Watches</maml:name> <maml:description> <maml:para>Specify the watches details to be returned using a watch query.</maml:para> </maml:description> <command:parameterValue required="false">WatchQuery</command:parameterValue> <dev:type> <maml:name>WatchQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Specify the workflow details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<RequestQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<RequestQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<RequestQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the request query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a request properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RequestField[]</command:parameterValue> <dev:type> <maml:name>RequestField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">RequestView</command:parameterValue> <dev:type> <maml:name>RequestView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">RequestOrderField</command:parameterValue> <dev:type> <maml:name>RequestOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AffectedSlas</maml:name> <maml:description> <maml:para>Specify the affected SLAs details to be returned using an affected service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">AffectedSlaQuery</command:parameterValue> <dev:type> <maml:name>AffectedSlaQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>AgileBoardColumn</maml:name> <maml:description> <maml:para>Specify the agile board column details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Specify the created by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Feedback</maml:name> <maml:description> <maml:para>Specify the feedback details to be returned using a feedback query.</maml:para> </maml:description> <command:parameterValue required="false">FeedbackQuery</command:parameterValue> <dev:type> <maml:name>FeedbackQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>FeedbackOnKnowledgeArticle</maml:name> <maml:description> <maml:para>Specify the feedback on knowledge article details to be returned using a knowledge article query.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>GroupedInto</maml:name> <maml:description> <maml:para>Specify the grouped into details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>GroupedRequests</maml:name> <maml:description> <maml:para>Specify the grouped requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>KnowledgeArticles</maml:name> <maml:description> <maml:para>Specify the knowledge articles details to be returned using a knowledge article query.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specify the member details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Specify the organization details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Problem</maml:name> <maml:description> <maml:para>Specify the problem details to be returned using a problem query.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>ProductBacklog</maml:name> <maml:description> <maml:para>Specify the product backlog details to be returned using a product backlog query.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogQuery</command:parameterValue> <dev:type> <maml:name>ProductBacklogQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specify the project details to be returned using a project query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>RequestedBy</maml:name> <maml:description> <maml:para>Specify the requested by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>RequestedFor</maml:name> <maml:description> <maml:para>Specify the requested for details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>SprintBacklogItems</maml:name> <maml:description> <maml:para>Specify the sprint backlog items details to be returned using a sprint backlog item query.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemQuery</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify the tags details to be returned using a tag query.</maml:para> </maml:description> <command:parameterValue required="false">TagQuery</command:parameterValue> <dev:type> <maml:name>TagQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Task</maml:name> <maml:description> <maml:para>Specify the task details to be returned using a task query.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specify the template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>TimeEntries</maml:name> <maml:description> <maml:para>Specify the time entries details to be returned using a time entry query.</maml:para> </maml:description> <command:parameterValue required="false">TimeEntryQuery</command:parameterValue> <dev:type> <maml:name>TimeEntryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>Watches</maml:name> <maml:description> <maml:para>Specify the watches details to be returned using a watch query.</maml:para> </maml:description> <command:parameterValue required="false">WatchQuery</command:parameterValue> <dev:type> <maml:name>WatchQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Specify the workflow details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<RequestQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<RequestQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<RequestQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestField[]</maml:name> </dev:type> <maml:description> <maml:para>The Request field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestView</maml:name> </dev:type> <maml:description> <maml:para>The request view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestOrderField</maml:name> </dev:type> <maml:description> <maml:para>The request order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AffectedSlaQuery</maml:name> </dev:type> <maml:description> <maml:para>An affected service level agreement query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardColumnQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board column query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FeedbackQuery</maml:name> </dev:type> <maml:description> <maml:para>A feedback query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleQuery</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteQuery</maml:name> </dev:type> <maml:description> <maml:para>A note query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemQuery</maml:name> </dev:type> <maml:description> <maml:para>A problem query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductBacklogQuery</maml:name> </dev:type> <maml:description> <maml:para>A product backlog query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectQuery</maml:name> </dev:type> <maml:description> <maml:para>A project query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintBacklogItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A sprint backlog item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TagQuery</maml:name> </dev:type> <maml:description> <maml:para>A tag query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A request template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeEntryQuery</maml:name> </dev:type> <maml:description> <maml:para>A time entry query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WatchQuery</maml:name> </dev:type> <maml:description> <maml:para>A watch query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<RequestQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A request query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRequestQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentRequestQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new request query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentRequestQueryFilter cmdlet creates and configures a request query filter object using the provided parameters. These filters can be used with the New-XurrentRequestQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRequestQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">RequestFilter</command:parameterValue> <dev:type> <maml:name>RequestFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">RequestFilter</command:parameterValue> <dev:type> <maml:name>RequestFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestFilter</maml:name> </dev:type> <maml:description> <maml:para>a request filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<RequestQuery></maml:name> </dev:type> <maml:description> <maml:para>A request query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRequestTemplate</command:name> <command:verb>New</command:verb> <command:noun>XurrentRequestTemplate</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new request template.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a request template using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRequestTemplate</maml:name> <command:parameter required="true" position="0"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AssetSelection</maml:name> <maml:description> <maml:para>After selecting the request template in Self Service, the user needs to be able to select a configuration item in the Asset field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AssignToSelf</maml:name> <maml:description> <maml:para>Whether the person who is registering a new request based on the template is selected in its Member field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestCategory</command:parameterValue> <dev:type> <maml:name>RequestCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>The completion reason that needs to be selected in the Completion reason field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestCompletionReason</command:parameterValue> <dev:type> <maml:name>RequestCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ConfigurationItemId</maml:name> <maml:description> <maml:para>Identifier of the CI that needs to be copied to the Configuration item field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CopySubjectToRequests</maml:name> <maml:description> <maml:para>Whether the subject of the request template needs to become the subject of a request when the template is applied, provided that the Subject field of this request is empty.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DesiredCompletion</maml:name> <maml:description> <maml:para>Used to enter the number of minutes within which requests that are based on the request template are to be resolved.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the request template may not be used to help register new requests.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a request that is based on the request template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>EndUsers</maml:name> <maml:description> <maml:para>Whether the request template is shown to end users in Self Service.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Impact</maml:name> <maml:description> <maml:para>The impact level that needs to be selected in the Impact field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestImpact</command:parameterValue> <dev:type> <maml:name>RequestImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Instructions for the support staff who will work on requests that are based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Keywords</maml:name> <maml:description> <maml:para>A comma-separated list of words that can be used to find the request template using search.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person who should be selected in the Member field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>RegistrationHints</maml:name> <maml:description> <maml:para>The information that needs to be displayed after the template has been applied to a new or existing request. This field typically contains step-by-step instructions about how to complete the registration of a request that is based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ReservationOfferingIds</maml:name> <maml:description> <maml:para>Identifiers of reservation offerings related to the request template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the request template is made available.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Specialists</maml:name> <maml:description> <maml:para>Whether the request template is shown to Specialists.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Status</maml:name> <maml:description> <maml:para>Used to select the status value that needs to be selected in the Status field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestStatus</command:parameterValue> <dev:type> <maml:name>RequestStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that should be selected in the Supplier field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SupportHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that is to be used to calculate the desired completion for requests that are based on the request template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team that should be selected in the Team field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected support hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether a new request that is created based on the template is to be marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>Identifier of the Workflow Manager linked to the request template. Required when a Workflow Template is defined, and the Service does not define a Workflow Manager.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>WorkflowTemplateId</maml:name> <maml:description> <maml:para>Identifier of the Workflow Template related to the request template. Required when the Status is set to _Workflow Pending_.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="32"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of request template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RequestTemplateField[]</command:parameterValue> <dev:type> <maml:name>RequestTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AssetSelection</maml:name> <maml:description> <maml:para>After selecting the request template in Self Service, the user needs to be able to select a configuration item in the Asset field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AssignToSelf</maml:name> <maml:description> <maml:para>Whether the person who is registering a new request based on the template is selected in its Member field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestCategory</command:parameterValue> <dev:type> <maml:name>RequestCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>The completion reason that needs to be selected in the Completion reason field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestCompletionReason</command:parameterValue> <dev:type> <maml:name>RequestCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ConfigurationItemId</maml:name> <maml:description> <maml:para>Identifier of the CI that needs to be copied to the Configuration item field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CopySubjectToRequests</maml:name> <maml:description> <maml:para>Whether the subject of the request template needs to become the subject of a request when the template is applied, provided that the Subject field of this request is empty.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DesiredCompletion</maml:name> <maml:description> <maml:para>Used to enter the number of minutes within which requests that are based on the request template are to be resolved.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the request template may not be used to help register new requests.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a request that is based on the request template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>EndUsers</maml:name> <maml:description> <maml:para>Whether the request template is shown to end users in Self Service.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Impact</maml:name> <maml:description> <maml:para>The impact level that needs to be selected in the Impact field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestImpact</command:parameterValue> <dev:type> <maml:name>RequestImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Instructions for the support staff who will work on requests that are based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Keywords</maml:name> <maml:description> <maml:para>A comma-separated list of words that can be used to find the request template using search.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person who should be selected in the Member field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>RegistrationHints</maml:name> <maml:description> <maml:para>The information that needs to be displayed after the template has been applied to a new or existing request. This field typically contains step-by-step instructions about how to complete the registration of a request that is based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ReservationOfferingIds</maml:name> <maml:description> <maml:para>Identifiers of reservation offerings related to the request template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the request template is made available.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Specialists</maml:name> <maml:description> <maml:para>Whether the request template is shown to Specialists.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Status</maml:name> <maml:description> <maml:para>Used to select the status value that needs to be selected in the Status field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestStatus</command:parameterValue> <dev:type> <maml:name>RequestStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that should be selected in the Supplier field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SupportHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that is to be used to calculate the desired completion for requests that are based on the request template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team that should be selected in the Team field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected support hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether a new request that is created based on the template is to be marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>Identifier of the Workflow Manager linked to the request template. Required when a Workflow Template is defined, and the Service does not define a Workflow Manager.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>WorkflowTemplateId</maml:name> <maml:description> <maml:para>Identifier of the Workflow Template related to the request template. Required when the Status is set to _Workflow Pending_.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="32"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of request template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RequestTemplateField[]</command:parameterValue> <dev:type> <maml:name>RequestTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestCategory</maml:name> </dev:type> <maml:description> <maml:para>A request category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestCompletionReason</maml:name> </dev:type> <maml:description> <maml:para>A request completion reason object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestImpact</maml:name> </dev:type> <maml:description> <maml:para>A request impact object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestStatus</maml:name> </dev:type> <maml:description> <maml:para>A request status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The request template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RequestTemplate</maml:name> </dev:type> <maml:description> <maml:para>A request template object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRequestTemplateQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentRequestTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a request template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentRequestTemplateQuery cmdlet creates and configures a request template query object using the provided parameters. These result can be used with the Invoke-XurrentRequestTemplateQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRequestTemplateQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the request template query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a request template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RequestTemplateField[]</command:parameterValue> <dev:type> <maml:name>RequestTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateView</command:parameterValue> <dev:type> <maml:name>RequestTemplateView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateOrderField</command:parameterValue> <dev:type> <maml:name>RequestTemplateOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>Specify the configuration item details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specify the member details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>Specify the note attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Organizations</maml:name> <maml:description> <maml:para>Specify the organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RegistrationHintsAttachments</maml:name> <maml:description> <maml:para>Specify the registration hints attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Requests</maml:name> <maml:description> <maml:para>Specify the requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ReservationOfferings</maml:name> <maml:description> <maml:para>Specify the reservation offerings details to be returned using a reservation offering query.</maml:para> </maml:description> <command:parameterValue required="false">ReservationOfferingQuery</command:parameterValue> <dev:type> <maml:name>ReservationOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>StandardServiceRequests</maml:name> <maml:description> <maml:para>Specify the standard service requests details to be returned using a standard service request query.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestQuery</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SupportHours</maml:name> <maml:description> <maml:para>Specify the support hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>WorkflowManager</maml:name> <maml:description> <maml:para>Specify the workflow manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>WorkflowTemplate</maml:name> <maml:description> <maml:para>Specify the workflow template details to be returned using a workflow template query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<RequestTemplateQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<RequestTemplateQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<RequestTemplateQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the request template query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a request template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RequestTemplateField[]</command:parameterValue> <dev:type> <maml:name>RequestTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateView</command:parameterValue> <dev:type> <maml:name>RequestTemplateView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateOrderField</command:parameterValue> <dev:type> <maml:name>RequestTemplateOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>Specify the configuration item details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specify the member details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>Specify the note attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Organizations</maml:name> <maml:description> <maml:para>Specify the organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RegistrationHintsAttachments</maml:name> <maml:description> <maml:para>Specify the registration hints attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Requests</maml:name> <maml:description> <maml:para>Specify the requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ReservationOfferings</maml:name> <maml:description> <maml:para>Specify the reservation offerings details to be returned using a reservation offering query.</maml:para> </maml:description> <command:parameterValue required="false">ReservationOfferingQuery</command:parameterValue> <dev:type> <maml:name>ReservationOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>StandardServiceRequests</maml:name> <maml:description> <maml:para>Specify the standard service requests details to be returned using a standard service request query.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestQuery</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SupportHours</maml:name> <maml:description> <maml:para>Specify the support hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>WorkflowManager</maml:name> <maml:description> <maml:para>Specify the workflow manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>WorkflowTemplate</maml:name> <maml:description> <maml:para>Specify the workflow template details to be returned using a workflow template query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<RequestTemplateQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<RequestTemplateQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<RequestTemplateQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The Request template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateView</maml:name> </dev:type> <maml:description> <maml:para>The request template view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateOrderField</maml:name> </dev:type> <maml:description> <maml:para>The request template order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>A reservation offering query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.StandardServiceRequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A standard service request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<RequestTemplateQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A request template query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A request template query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRequestTemplateQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentRequestTemplateQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new request template query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentRequestTemplateQueryFilter cmdlet creates and configures a request template query filter object using the provided parameters. These filters can be used with the New-XurrentRequestTemplateQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRequestTemplateQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">RequestTemplateFilter</command:parameterValue> <dev:type> <maml:name>RequestTemplateFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">RequestTemplateFilter</command:parameterValue> <dev:type> <maml:name>RequestTemplateFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateFilter</maml:name> </dev:type> <maml:description> <maml:para>a request template filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<RequestTemplateQuery></maml:name> </dev:type> <maml:description> <maml:para>A request template query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentReservation</command:name> <command:verb>New</command:verb> <command:noun>XurrentReservation</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new reservation.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a reservation using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentReservation</maml:name> <command:parameter required="true" position="0"> <maml:name>ConfigurationItemId</maml:name> <maml:description> <maml:para>Identifier of the asset that is being reserved.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>A short description of the reservation</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person for whom this reservation was created.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>ReservationOfferingId</maml:name> <maml:description> <maml:para>Identifier of the reservation offering that was used to create this reservation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Used to specify the start date and time of the reservation.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CreatedById</maml:name> <maml:description> <maml:para>Identifier of the person who created this reservation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Description</maml:name> <maml:description> <maml:para>Full description of the reservation</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Duration</maml:name> <maml:description> <maml:para>The duration of the reservation during the calendar hours of the reservation offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>Used to specify the end date and time of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>PreparationStartAt</maml:name> <maml:description> <maml:para>The start date and time of the preparation of the asset for the reservation. Only present in case the reservation offering specifies a preparation duration.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for the reservation.</maml:para> </maml:description> <command:parameterValue required="false">ReservationRecurrenceInput</command:parameterValue> <dev:type> <maml:name>ReservationRecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Identifier of the request for reservation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">ReservationStatus</command:parameterValue> <dev:type> <maml:name>ReservationStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="17"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of reservation properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReservationField[]</command:parameterValue> <dev:type> <maml:name>ReservationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ConfigurationItemId</maml:name> <maml:description> <maml:para>Identifier of the asset that is being reserved.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>A short description of the reservation</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person for whom this reservation was created.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>ReservationOfferingId</maml:name> <maml:description> <maml:para>Identifier of the reservation offering that was used to create this reservation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Used to specify the start date and time of the reservation.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CreatedById</maml:name> <maml:description> <maml:para>Identifier of the person who created this reservation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Description</maml:name> <maml:description> <maml:para>Full description of the reservation</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Duration</maml:name> <maml:description> <maml:para>The duration of the reservation during the calendar hours of the reservation offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>Used to specify the end date and time of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>PreparationStartAt</maml:name> <maml:description> <maml:para>The start date and time of the preparation of the asset for the reservation. Only present in case the reservation offering specifies a preparation duration.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for the reservation.</maml:para> </maml:description> <command:parameterValue required="false">ReservationRecurrenceInput</command:parameterValue> <dev:type> <maml:name>ReservationRecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Identifier of the request for reservation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">ReservationStatus</command:parameterValue> <dev:type> <maml:name>ReservationStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="17"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of reservation properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReservationField[]</command:parameterValue> <dev:type> <maml:name>ReservationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationRecurrenceInput</maml:name> </dev:type> <maml:description> <maml:para>A reservation recurrence input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationStatus</maml:name> </dev:type> <maml:description> <maml:para>A reservation status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationField[]</maml:name> </dev:type> <maml:description> <maml:para>The reservation field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Reservation</maml:name> </dev:type> <maml:description> <maml:para>A reservation object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentReservationOffering</command:name> <command:verb>New</command:verb> <command:noun>XurrentReservationOffering</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new reservation offering.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a reservation offering using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentReservationOffering</maml:name> <command:parameter required="true" position="0"> <maml:name>CalendarId</maml:name> <maml:description> <maml:para>Calendar that defines the hours in which reservations may start and end.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>MaxDuration</maml:name> <maml:description> <maml:para>The maximum duration of the reservation within the hours of the calendar.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>MinDuration</maml:name> <maml:description> <maml:para>The minimum duration of the reservation within the hours of the calendar.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>A short description of the reservation offering</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>StepDuration</maml:name> <maml:description> <maml:para>The increments with which the reservation may be prolonged.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected calendar.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AllowRepeat</maml:name> <maml:description> <maml:para>Whether it is allowed to create recurrent reservations for this offering.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items that may be reserved using this offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the reservation offering may not be used to register requests for reservation.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>The filters of the reservation offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>InitialStatus</maml:name> <maml:description> <maml:para>The initial status of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">ReservationStatus</command:parameterValue> <dev:type> <maml:name>ReservationStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>MaxAdvanceDuration</maml:name> <maml:description> <maml:para>The maximum duration between the creation time of a request for reservation and the requested start of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>MinAdvanceDuration</maml:name> <maml:description> <maml:para>The minimum duration between the creation time of a request for reservation and the requested start of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>MultiDay</maml:name> <maml:description> <maml:para>Whether or not the reservation may span over multiple calendar days.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PreparationDuration</maml:name> <maml:description> <maml:para>The duration required to prepare the asset before the reservation starts.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>PrivateReservations</maml:name> <maml:description> <maml:para>Reservations of this reservation offering are private and can not be viewed by other end users.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the service instance for which the reservations may be requested.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="20"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of reservation offering properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReservationOfferingField[]</command:parameterValue> <dev:type> <maml:name>ReservationOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>CalendarId</maml:name> <maml:description> <maml:para>Calendar that defines the hours in which reservations may start and end.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>MaxDuration</maml:name> <maml:description> <maml:para>The maximum duration of the reservation within the hours of the calendar.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>MinDuration</maml:name> <maml:description> <maml:para>The minimum duration of the reservation within the hours of the calendar.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>A short description of the reservation offering</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>StepDuration</maml:name> <maml:description> <maml:para>The increments with which the reservation may be prolonged.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected calendar.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AllowRepeat</maml:name> <maml:description> <maml:para>Whether it is allowed to create recurrent reservations for this offering.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items that may be reserved using this offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the reservation offering may not be used to register requests for reservation.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>The filters of the reservation offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>InitialStatus</maml:name> <maml:description> <maml:para>The initial status of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">ReservationStatus</command:parameterValue> <dev:type> <maml:name>ReservationStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>MaxAdvanceDuration</maml:name> <maml:description> <maml:para>The maximum duration between the creation time of a request for reservation and the requested start of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>MinAdvanceDuration</maml:name> <maml:description> <maml:para>The minimum duration between the creation time of a request for reservation and the requested start of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>MultiDay</maml:name> <maml:description> <maml:para>Whether or not the reservation may span over multiple calendar days.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PreparationDuration</maml:name> <maml:description> <maml:para>The duration required to prepare the asset before the reservation starts.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>PrivateReservations</maml:name> <maml:description> <maml:para>Reservations of this reservation offering are private and can not be viewed by other end users.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the service instance for which the reservations may be requested.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="20"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of reservation offering properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReservationOfferingField[]</command:parameterValue> <dev:type> <maml:name>ReservationOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationStatus</maml:name> </dev:type> <maml:description> <maml:para>A reservation status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationOfferingField[]</maml:name> </dev:type> <maml:description> <maml:para>The reservation offering field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ReservationOffering</maml:name> </dev:type> <maml:description> <maml:para>A reservation offering object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentReservationOfferingQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentReservationOfferingQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a reservation offering query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentReservationOfferingQuery cmdlet creates and configures a reservation offering query object using the provided parameters. These result can be used with the Invoke-XurrentReservationOfferingQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentReservationOfferingQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the reservation offering query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a reservation offering properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReservationOfferingField[]</command:parameterValue> <dev:type> <maml:name>ReservationOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ReservationOfferingView</command:parameterValue> <dev:type> <maml:name>ReservationOfferingView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ReservationOfferingOrderField</command:parameterValue> <dev:type> <maml:name>ReservationOfferingOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Calendar</maml:name> <maml:description> <maml:para>Specify the calendar details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>RequestTemplates</maml:name> <maml:description> <maml:para>Specify the request templates details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ReservationOfferingQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ReservationOfferingQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ReservationOfferingQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the reservation offering query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a reservation offering properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReservationOfferingField[]</command:parameterValue> <dev:type> <maml:name>ReservationOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ReservationOfferingView</command:parameterValue> <dev:type> <maml:name>ReservationOfferingView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ReservationOfferingOrderField</command:parameterValue> <dev:type> <maml:name>ReservationOfferingOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Calendar</maml:name> <maml:description> <maml:para>Specify the calendar details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>RequestTemplates</maml:name> <maml:description> <maml:para>Specify the request templates details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ReservationOfferingQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ReservationOfferingQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ReservationOfferingQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationOfferingField[]</maml:name> </dev:type> <maml:description> <maml:para>The Reservation offering field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationOfferingView</maml:name> </dev:type> <maml:description> <maml:para>The reservation offering view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationOfferingOrderField</maml:name> </dev:type> <maml:description> <maml:para>The reservation offering order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A request template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ReservationOfferingQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A reservation offering query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ReservationOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>A reservation offering query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentReservationOfferingQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentReservationOfferingQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new reservation offering query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentReservationOfferingQueryFilter cmdlet creates and configures a reservation offering query filter object using the provided parameters. These filters can be used with the New-XurrentReservationOfferingQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentReservationOfferingQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ReservationOfferingFilter</command:parameterValue> <dev:type> <maml:name>ReservationOfferingFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ReservationOfferingFilter</command:parameterValue> <dev:type> <maml:name>ReservationOfferingFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationOfferingFilter</maml:name> </dev:type> <maml:description> <maml:para>a reservation offering filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ReservationOfferingQuery></maml:name> </dev:type> <maml:description> <maml:para>A reservation offering query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentReservationQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentReservationQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a reservation query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentReservationQuery cmdlet creates and configures a reservation query object using the provided parameters. These result can be used with the Invoke-XurrentReservationQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentReservationQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the reservation query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a reservation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReservationField[]</command:parameterValue> <dev:type> <maml:name>ReservationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ReservationView</command:parameterValue> <dev:type> <maml:name>ReservationView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ReservationOrderField</command:parameterValue> <dev:type> <maml:name>ReservationOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>Specify the configuration item details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Specify the created by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Specify the recurrence details to be returned using a recurrence query.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceQuery</command:parameterValue> <dev:type> <maml:name>RecurrenceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Request</maml:name> <maml:description> <maml:para>Specify the request details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ReservationOffering</maml:name> <maml:description> <maml:para>Specify the reservation offering details to be returned using a reservation offering query.</maml:para> </maml:description> <command:parameterValue required="false">ReservationOfferingQuery</command:parameterValue> <dev:type> <maml:name>ReservationOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ReservationQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ReservationQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ReservationQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the reservation query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a reservation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReservationField[]</command:parameterValue> <dev:type> <maml:name>ReservationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ReservationView</command:parameterValue> <dev:type> <maml:name>ReservationView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ReservationOrderField</command:parameterValue> <dev:type> <maml:name>ReservationOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>Specify the configuration item details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Specify the created by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Specify the recurrence details to be returned using a recurrence query.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceQuery</command:parameterValue> <dev:type> <maml:name>RecurrenceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Request</maml:name> <maml:description> <maml:para>Specify the request details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ReservationOffering</maml:name> <maml:description> <maml:para>Specify the reservation offering details to be returned using a reservation offering query.</maml:para> </maml:description> <command:parameterValue required="false">ReservationOfferingQuery</command:parameterValue> <dev:type> <maml:name>ReservationOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ReservationQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ReservationQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ReservationQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationField[]</maml:name> </dev:type> <maml:description> <maml:para>The Reservation field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationView</maml:name> </dev:type> <maml:description> <maml:para>The reservation view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationOrderField</maml:name> </dev:type> <maml:description> <maml:para>The reservation order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecurrenceQuery</maml:name> </dev:type> <maml:description> <maml:para>A recurrence query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>A reservation offering query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ReservationQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A reservation query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ReservationQuery</maml:name> </dev:type> <maml:description> <maml:para>A reservation query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentReservationQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentReservationQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new reservation query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentReservationQueryFilter cmdlet creates and configures a reservation query filter object using the provided parameters. These filters can be used with the New-XurrentReservationQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentReservationQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ReservationFilter</command:parameterValue> <dev:type> <maml:name>ReservationFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ReservationFilter</command:parameterValue> <dev:type> <maml:name>ReservationFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationFilter</maml:name> </dev:type> <maml:description> <maml:para>a reservation filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ReservationQuery></maml:name> </dev:type> <maml:description> <maml:para>A reservation query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRisk</command:name> <command:verb>New</command:verb> <command:noun>XurrentRisk</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new risk.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a risk using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRisk</maml:name> <command:parameter required="true" position="0"> <maml:name>Severity</maml:name> <maml:description> <maml:para>The severity of the risk.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Subject</maml:name> <maml:description> <maml:para>The subject of the risk.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClosureReason</maml:name> <maml:description> <maml:para>The appropriate closure reason for the risk when it has been closed.</maml:para> </maml:description> <command:parameterValue required="false">RiskClosureReason</command:parameterValue> <dev:type> <maml:name>RiskClosureReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the manager of the risk. This person is able to maintain the information about the risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MitigationTargetAt</maml:name> <maml:description> <maml:para>The date by which the risk should have been mitigated.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Note</maml:name> <maml:description> <maml:para>The Note field is used to provide a detailed description of the risk and the actions that are planned or have already been taken to eliminate it, or to minimize its severity. This field is also used when the status is set to closed to explain why it was decided to close the risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of organizations linked to the risk.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ProjectIds</maml:name> <maml:description> <maml:para>Identifiers of projects linked to the risk.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ServiceIds</maml:name> <maml:description> <maml:para>Identifiers of services linked to the risk.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the risk.</maml:para> </maml:description> <command:parameterValue required="false">RiskStatus</command:parameterValue> <dev:type> <maml:name>RiskStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="16"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of risk properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RiskField[]</command:parameterValue> <dev:type> <maml:name>RiskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Severity</maml:name> <maml:description> <maml:para>The severity of the risk.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Subject</maml:name> <maml:description> <maml:para>The subject of the risk.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClosureReason</maml:name> <maml:description> <maml:para>The appropriate closure reason for the risk when it has been closed.</maml:para> </maml:description> <command:parameterValue required="false">RiskClosureReason</command:parameterValue> <dev:type> <maml:name>RiskClosureReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the manager of the risk. This person is able to maintain the information about the risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MitigationTargetAt</maml:name> <maml:description> <maml:para>The date by which the risk should have been mitigated.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Note</maml:name> <maml:description> <maml:para>The Note field is used to provide a detailed description of the risk and the actions that are planned or have already been taken to eliminate it, or to minimize its severity. This field is also used when the status is set to closed to explain why it was decided to close the risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of organizations linked to the risk.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ProjectIds</maml:name> <maml:description> <maml:para>Identifiers of projects linked to the risk.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ServiceIds</maml:name> <maml:description> <maml:para>Identifiers of services linked to the risk.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the risk.</maml:para> </maml:description> <command:parameterValue required="false">RiskStatus</command:parameterValue> <dev:type> <maml:name>RiskStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="16"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of risk properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RiskField[]</command:parameterValue> <dev:type> <maml:name>RiskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskClosureReason</maml:name> </dev:type> <maml:description> <maml:para>A risk closure reason object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskStatus</maml:name> </dev:type> <maml:description> <maml:para>A risk status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskField[]</maml:name> </dev:type> <maml:description> <maml:para>The risk field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Risk</maml:name> </dev:type> <maml:description> <maml:para>A risk object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRiskQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentRiskQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a risk query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentRiskQuery cmdlet creates and configures a risk query object using the provided parameters. These result can be used with the Invoke-XurrentRiskQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRiskQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the risk query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a risk properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RiskField[]</command:parameterValue> <dev:type> <maml:name>RiskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">RiskView</command:parameterValue> <dev:type> <maml:name>RiskView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">RiskOrderField</command:parameterValue> <dev:type> <maml:name>RiskOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Organizations</maml:name> <maml:description> <maml:para>Specify the organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Projects</maml:name> <maml:description> <maml:para>Specify the projects details to be returned using a project query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Services</maml:name> <maml:description> <maml:para>Specify the services details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<RiskQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<RiskQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<RiskQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the risk query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a risk properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RiskField[]</command:parameterValue> <dev:type> <maml:name>RiskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">RiskView</command:parameterValue> <dev:type> <maml:name>RiskView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">RiskOrderField</command:parameterValue> <dev:type> <maml:name>RiskOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Organizations</maml:name> <maml:description> <maml:para>Specify the organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Projects</maml:name> <maml:description> <maml:para>Specify the projects details to be returned using a project query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Services</maml:name> <maml:description> <maml:para>Specify the services details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<RiskQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<RiskQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<RiskQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskField[]</maml:name> </dev:type> <maml:description> <maml:para>The Risk field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskView</maml:name> </dev:type> <maml:description> <maml:para>The risk view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskOrderField</maml:name> </dev:type> <maml:description> <maml:para>The risk order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteQuery</maml:name> </dev:type> <maml:description> <maml:para>A note query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectQuery</maml:name> </dev:type> <maml:description> <maml:para>A project query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<RiskQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A risk query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RiskQuery</maml:name> </dev:type> <maml:description> <maml:para>A risk query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRiskQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentRiskQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new risk query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentRiskQueryFilter cmdlet creates and configures a risk query filter object using the provided parameters. These filters can be used with the New-XurrentRiskQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRiskQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">RiskFilter</command:parameterValue> <dev:type> <maml:name>RiskFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">RiskFilter</command:parameterValue> <dev:type> <maml:name>RiskFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskFilter</maml:name> </dev:type> <maml:description> <maml:para>a risk filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<RiskQuery></maml:name> </dev:type> <maml:description> <maml:para>A risk query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRiskSeverity</command:name> <command:verb>New</command:verb> <command:noun>XurrentRiskSeverity</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new risk severity.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a risk severity using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRiskSeverity</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the risk severity. Ideally the name of a risk severity consists of a single word, such as "High".</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A very short description of the risk severity, for example "Risk is Significant".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the risk severity may not be related to any more risks.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the risk severity that might prove useful, especially for risk managers when they need to decide which severity to select for a risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the risk severity takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of risk severity properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RiskSeverityField[]</command:parameterValue> <dev:type> <maml:name>RiskSeverityField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the risk severity. Ideally the name of a risk severity consists of a single word, such as "High".</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A very short description of the risk severity, for example "Risk is Significant".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the risk severity may not be related to any more risks.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the risk severity that might prove useful, especially for risk managers when they need to decide which severity to select for a risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the risk severity takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of risk severity properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RiskSeverityField[]</command:parameterValue> <dev:type> <maml:name>RiskSeverityField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskSeverityField[]</maml:name> </dev:type> <maml:description> <maml:para>The risk severity field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RiskSeverity</maml:name> </dev:type> <maml:description> <maml:para>A risk severity object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRiskSeverityQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentRiskSeverityQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a risk severity query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentRiskSeverityQuery cmdlet creates and configures a risk severity query object using the provided parameters. These result can be used with the Invoke-XurrentRiskSeverityQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRiskSeverityQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the risk severity query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a risk severity properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RiskSeverityField[]</command:parameterValue> <dev:type> <maml:name>RiskSeverityField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<RiskSeverityQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<RiskSeverityQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<RiskSeverityQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the risk severity query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a risk severity properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RiskSeverityField[]</command:parameterValue> <dev:type> <maml:name>RiskSeverityField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<RiskSeverityQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<RiskSeverityQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<RiskSeverityQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskSeverityField[]</maml:name> </dev:type> <maml:description> <maml:para>The Risk severity field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<RiskSeverityQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A risk severity query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RiskSeverityQuery</maml:name> </dev:type> <maml:description> <maml:para>A risk severity query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentRiskSeverityQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentRiskSeverityQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new risk severity query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentRiskSeverityQueryFilter cmdlet creates and configures a risk severity query filter object using the provided parameters. These filters can be used with the New-XurrentRiskSeverityQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentRiskSeverityQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">RiskSeverityFilter</command:parameterValue> <dev:type> <maml:name>RiskSeverityFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">RiskSeverityFilter</command:parameterValue> <dev:type> <maml:name>RiskSeverityFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskSeverityFilter</maml:name> </dev:type> <maml:description> <maml:para>a risk severity filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<RiskSeverityQuery></maml:name> </dev:type> <maml:description> <maml:para>A risk severity query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentScrumWorkspace</command:name> <command:verb>New</command:verb> <command:noun>XurrentScrumWorkspace</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new scrum workspace.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a scrum workspace using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentScrumWorkspace</maml:name> <command:parameter required="true" position="0"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>Identifier of the agile board used to track the progress of this workspace's active sprint.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the scrum workspace.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ProductBacklogId</maml:name> <maml:description> <maml:para>Identifier of the product backlog used when planning sprints.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>SprintLength</maml:name> <maml:description> <maml:para>Standard length in weeks of new sprints planned in this scrum workspace.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team planning their work using this scrum workspace.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>Additional information regarding the scrum workspace.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the scrum workspace is in use.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="12"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of scrum workspace properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ScrumWorkspaceField[]</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>Identifier of the agile board used to track the progress of this workspace's active sprint.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the scrum workspace.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ProductBacklogId</maml:name> <maml:description> <maml:para>Identifier of the product backlog used when planning sprints.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>SprintLength</maml:name> <maml:description> <maml:para>Standard length in weeks of new sprints planned in this scrum workspace.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team planning their work using this scrum workspace.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>Additional information regarding the scrum workspace.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the scrum workspace is in use.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="12"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of scrum workspace properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ScrumWorkspaceField[]</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ScrumWorkspaceField[]</maml:name> </dev:type> <maml:description> <maml:para>The scrum workspace field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ScrumWorkspace</maml:name> </dev:type> <maml:description> <maml:para>A scrum workspace object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentScrumWorkspaceQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentScrumWorkspaceQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a scrum workspace query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentScrumWorkspaceQuery cmdlet creates and configures a scrum workspace query object using the provided parameters. These result can be used with the Invoke-XurrentScrumWorkspaceQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentScrumWorkspaceQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the scrum workspace query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a scrum workspace properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ScrumWorkspaceField[]</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ScrumWorkspaceView</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ScrumWorkspaceOrderField</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ProductBacklog</maml:name> <maml:description> <maml:para>Specify the product backlog details to be returned using a product backlog query.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogQuery</command:parameterValue> <dev:type> <maml:name>ProductBacklogQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Sprints</maml:name> <maml:description> <maml:para>Specify the sprints details to be returned using a sprint query.</maml:para> </maml:description> <command:parameterValue required="false">SprintQuery</command:parameterValue> <dev:type> <maml:name>SprintQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ScrumWorkspaceQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ScrumWorkspaceQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ScrumWorkspaceQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the scrum workspace query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a scrum workspace properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ScrumWorkspaceField[]</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ScrumWorkspaceView</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ScrumWorkspaceOrderField</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ProductBacklog</maml:name> <maml:description> <maml:para>Specify the product backlog details to be returned using a product backlog query.</maml:para> </maml:description> <command:parameterValue required="false">ProductBacklogQuery</command:parameterValue> <dev:type> <maml:name>ProductBacklogQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Sprints</maml:name> <maml:description> <maml:para>Specify the sprints details to be returned using a sprint query.</maml:para> </maml:description> <command:parameterValue required="false">SprintQuery</command:parameterValue> <dev:type> <maml:name>SprintQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ScrumWorkspaceQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ScrumWorkspaceQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ScrumWorkspaceQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ScrumWorkspaceField[]</maml:name> </dev:type> <maml:description> <maml:para>The Scrum workspace field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ScrumWorkspaceView</maml:name> </dev:type> <maml:description> <maml:para>The scrum workspace view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ScrumWorkspaceOrderField</maml:name> </dev:type> <maml:description> <maml:para>The scrum workspace order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductBacklogQuery</maml:name> </dev:type> <maml:description> <maml:para>A product backlog query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintQuery</maml:name> </dev:type> <maml:description> <maml:para>A sprint query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ScrumWorkspaceQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A scrum workspace query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ScrumWorkspaceQuery</maml:name> </dev:type> <maml:description> <maml:para>A scrum workspace query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentScrumWorkspaceQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentScrumWorkspaceQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new scrum workspace query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentScrumWorkspaceQueryFilter cmdlet creates and configures a scrum workspace query filter object using the provided parameters. These filters can be used with the New-XurrentScrumWorkspaceQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentScrumWorkspaceQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ScrumWorkspaceFilter</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ScrumWorkspaceFilter</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ScrumWorkspaceFilter</maml:name> </dev:type> <maml:description> <maml:para>a scrum workspace filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ScrumWorkspaceQuery></maml:name> </dev:type> <maml:description> <maml:para>A scrum workspace query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentService</command:name> <command:verb>New</command:verb> <command:noun>XurrentService</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new service.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a service using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentService</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service. The service name may be followed by the name of its core application placed between brackets.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ProviderId</maml:name> <maml:description> <maml:para>Identifier of the organization who provides the service.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AvailabilityManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for ensuring that the availability targets specified in the active SLAs for the service are met.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CapacityManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for ensuring that the service is not affected by incidents that are caused by capacity shortages.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ChangeManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the changes of the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ContinuityManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for creating and maintaining the continuity plans for the service's instances that have an active SLA with a continuity target.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the service's core functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the service may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>FirstLineTeamId</maml:name> <maml:description> <maml:para>Identifier of the team that will, by default, be selected in the First line team field of a new service instance when it is being registered for the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Keywords</maml:name> <maml:description> <maml:para>A comma-separated list of words that can be used to find the service via search.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>KnowledgeManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for the quality of the knowledge articles for the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProblemManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the problems that directly affect the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ReleaseManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the releases of the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceOwnerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for ensuring that the service level targets specified in the SLAs for the service are met.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team that will, by default, be selected in the Support team field of a service instance when one is registered for the service. Similarly, this team will be selected in the Team field of a problem when the service is related to it.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SurveyId</maml:name> <maml:description> <maml:para>Identifier of the survey used to measure customer rating of this service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="24"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceField[]</command:parameterValue> <dev:type> <maml:name>ServiceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service. The service name may be followed by the name of its core application placed between brackets.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ProviderId</maml:name> <maml:description> <maml:para>Identifier of the organization who provides the service.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AvailabilityManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for ensuring that the availability targets specified in the active SLAs for the service are met.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CapacityManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for ensuring that the service is not affected by incidents that are caused by capacity shortages.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ChangeManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the changes of the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ContinuityManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for creating and maintaining the continuity plans for the service's instances that have an active SLA with a continuity target.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the service's core functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the service may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>FirstLineTeamId</maml:name> <maml:description> <maml:para>Identifier of the team that will, by default, be selected in the First line team field of a new service instance when it is being registered for the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Keywords</maml:name> <maml:description> <maml:para>A comma-separated list of words that can be used to find the service via search.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>KnowledgeManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for the quality of the knowledge articles for the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProblemManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the problems that directly affect the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ReleaseManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the releases of the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceOwnerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for ensuring that the service level targets specified in the SLAs for the service are met.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team that will, by default, be selected in the Support team field of a service instance when one is registered for the service. Similarly, this team will be selected in the Team field of a problem when the service is related to it.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SurveyId</maml:name> <maml:description> <maml:para>Identifier of the survey used to measure customer rating of this service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="24"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceField[]</command:parameterValue> <dev:type> <maml:name>ServiceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceField[]</maml:name> </dev:type> <maml:description> <maml:para>The service field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Service</maml:name> </dev:type> <maml:description> <maml:para>A service object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceCategory</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceCategory</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new service category.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a service category using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceCategory</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service category.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the type of services that are included in the service category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServiceIds</maml:name> <maml:description> <maml:para>Identifiers of the services of the service category.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="8"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceCategoryField[]</command:parameterValue> <dev:type> <maml:name>ServiceCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service category.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the type of services that are included in the service category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServiceIds</maml:name> <maml:description> <maml:para>Identifiers of the services of the service category.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="8"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceCategoryField[]</command:parameterValue> <dev:type> <maml:name>ServiceCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceCategoryField[]</maml:name> </dev:type> <maml:description> <maml:para>The service category field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceCategory</maml:name> </dev:type> <maml:description> <maml:para>A service category object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceCategoryQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceCategoryQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a service category query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentServiceCategoryQuery cmdlet creates and configures a service category query object using the provided parameters. These result can be used with the Invoke-XurrentServiceCategoryQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceCategoryQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the service category query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service category properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceCategoryField[]</command:parameterValue> <dev:type> <maml:name>ServiceCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Services</maml:name> <maml:description> <maml:para>Specify the services details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ServiceCategoryQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ServiceCategoryQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ServiceCategoryQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the service category query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service category properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceCategoryField[]</command:parameterValue> <dev:type> <maml:name>ServiceCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Services</maml:name> <maml:description> <maml:para>Specify the services details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ServiceCategoryQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ServiceCategoryQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ServiceCategoryQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceCategoryField[]</maml:name> </dev:type> <maml:description> <maml:para>The Service category field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ServiceCategoryQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A service category query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A service category query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceCategoryQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceCategoryQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new service category query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentServiceCategoryQueryFilter cmdlet creates and configures a service category query filter object using the provided parameters. These filters can be used with the New-XurrentServiceCategoryQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceCategoryQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ServiceCategoryFilter</command:parameterValue> <dev:type> <maml:name>ServiceCategoryFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ServiceCategoryFilter</command:parameterValue> <dev:type> <maml:name>ServiceCategoryFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceCategoryFilter</maml:name> </dev:type> <maml:description> <maml:para>a service category filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ServiceCategoryQuery></maml:name> </dev:type> <maml:description> <maml:para>A service category query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceInstance</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceInstance</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new service instance.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a service instance using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceInstance</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service instance.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service which functionality the service instance provides.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the service instance.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>FirstLineTeamId</maml:name> <maml:description> <maml:para>Idenifier of the team that will automatically be selected in the Team field of requests to which the service instance is linked after they have been submitted using Self Service or when they are generated using the Requests API, Mail API or Events API.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the service instance that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the service instance.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceStatus</command:parameterValue> <dev:type> <maml:name>ServiceInstanceStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team that will, by default, be selected in the Team field of a request when the service instance is manually selected in the Service instance field of the request, or when the service instance is applied from the Service Hierarchy Browser.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="15"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service instance properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceInstanceField[]</command:parameterValue> <dev:type> <maml:name>ServiceInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service instance.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service which functionality the service instance provides.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the service instance.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>FirstLineTeamId</maml:name> <maml:description> <maml:para>Idenifier of the team that will automatically be selected in the Team field of requests to which the service instance is linked after they have been submitted using Self Service or when they are generated using the Requests API, Mail API or Events API.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the service instance that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the service instance.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceStatus</command:parameterValue> <dev:type> <maml:name>ServiceInstanceStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team that will, by default, be selected in the Team field of a request when the service instance is manually selected in the Service instance field of the request, or when the service instance is applied from the Service Hierarchy Browser.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="15"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service instance properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceInstanceField[]</command:parameterValue> <dev:type> <maml:name>ServiceInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceStatus</maml:name> </dev:type> <maml:description> <maml:para>A service instance status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceField[]</maml:name> </dev:type> <maml:description> <maml:para>The service instance field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceInstance</maml:name> </dev:type> <maml:description> <maml:para>A service instance object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceInstanceQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceInstanceQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a service instance query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentServiceInstanceQuery cmdlet creates and configures a service instance query object using the provided parameters. These result can be used with the Invoke-XurrentServiceInstanceQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceInstanceQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the service instance query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service instance properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceInstanceField[]</command:parameterValue> <dev:type> <maml:name>ServiceInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceView</command:parameterValue> <dev:type> <maml:name>ServiceInstanceView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceOrderField</command:parameterValue> <dev:type> <maml:name>ServiceInstanceOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ChildServiceInstances</maml:name> <maml:description> <maml:para>Specify the child service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FirstLineTeam</maml:name> <maml:description> <maml:para>Specify the first line team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>MaintenanceWindow</maml:name> <maml:description> <maml:para>Specify the maintenance window details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ParentServiceInstances</maml:name> <maml:description> <maml:para>Specify the parent service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ServiceLevelAgreements</maml:name> <maml:description> <maml:para>Specify the service level agreements details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SupportTeam</maml:name> <maml:description> <maml:para>Specify the support team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ServiceInstanceQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ServiceInstanceQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ServiceInstanceQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the service instance query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service instance properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceInstanceField[]</command:parameterValue> <dev:type> <maml:name>ServiceInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceView</command:parameterValue> <dev:type> <maml:name>ServiceInstanceView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceOrderField</command:parameterValue> <dev:type> <maml:name>ServiceInstanceOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ChildServiceInstances</maml:name> <maml:description> <maml:para>Specify the child service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FirstLineTeam</maml:name> <maml:description> <maml:para>Specify the first line team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>MaintenanceWindow</maml:name> <maml:description> <maml:para>Specify the maintenance window details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ParentServiceInstances</maml:name> <maml:description> <maml:para>Specify the parent service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ServiceLevelAgreements</maml:name> <maml:description> <maml:para>Specify the service level agreements details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SupportTeam</maml:name> <maml:description> <maml:para>Specify the support team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ServiceInstanceQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ServiceInstanceQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ServiceInstanceQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceField[]</maml:name> </dev:type> <maml:description> <maml:para>The Service instance field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceView</maml:name> </dev:type> <maml:description> <maml:para>The service instance view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceOrderField</maml:name> </dev:type> <maml:description> <maml:para>The service instance order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ServiceInstanceQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A service instance query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceInstanceQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceInstanceQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new service instance query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentServiceInstanceQueryFilter cmdlet creates and configures a service instance query filter object using the provided parameters. These filters can be used with the New-XurrentServiceInstanceQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceInstanceQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ServiceInstanceFilter</command:parameterValue> <dev:type> <maml:name>ServiceInstanceFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ServiceInstanceFilter</command:parameterValue> <dev:type> <maml:name>ServiceInstanceFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceFilter</maml:name> </dev:type> <maml:description> <maml:para>a service instance filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ServiceInstanceQuery></maml:name> </dev:type> <maml:description> <maml:para>A service instance query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceLevelAgreement</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceLevelAgreement</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new service level agreement.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a service level agreement using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceLevelAgreement</maml:name> <command:parameter required="true" position="0"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization that pays for the service level agreement.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service level agreement.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ServiceOfferingId</maml:name> <maml:description> <maml:para>Identifier of the service offering that specifies the conditions that apply to the service level agreement.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ActivityID</maml:name> <maml:description> <maml:para>The Activity ID is the unique identifier by which an activity that is performed in the context of a service offering is known in the billing system of the service provider. This contains the activityIDs related to request categories.</maml:para> </maml:description> <command:parameterValue required="false">ActivityIDInput</command:parameterValue> <dev:type> <maml:name>ActivityIDInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AgreementID</maml:name> <maml:description> <maml:para>The Agreement ID is the unique identifier by which all the activities that are performed through the coverage of the SLA are known in the billing system of the service provider.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Coverage</maml:name> <maml:description> <maml:para>Used to specify how people who are to be covered by the service level agreement are to be selected.</maml:para> </maml:description> <command:parameterValue required="false">SlaCoverage</command:parameterValue> <dev:type> <maml:name>SlaCoverage</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomerAccountId</maml:name> <maml:description> <maml:para>Identifier of the account which service level managers are allowed to update the parts of the SLA that are intended to be maintained by the service level managers of the customer. More importantly, this field is used to specify whether specialists of the customer are allowed to see the requests that include this SLA in their Affected SLAs section.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomerRepresentativeIds</maml:name> <maml:description> <maml:para>Identifiers of the people who represents the customer organization for the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ExpiryDate</maml:name> <maml:description> <maml:para>The date through which the service level agreement (SLA) will be active. The SLA expires at the end of this day if it is not renewed before then. When the SLA has expired, its status will automatically be set to "Expired".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>NewEffortClassRateIDs</maml:name> <maml:description> <maml:para>The Rate IDs are the unique identifiers by which an effort class that is linked to a time entry when an activity was performed through the coverage of the SLA is known in the billing system of the service provider.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassRateIDInput[]</command:parameterValue> <dev:type> <maml:name>EffortClassRateIDInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>NewStandardServiceRequestActivityIDs</maml:name> <maml:description> <maml:para>Represents the activityIDs for standard service requests. The Activity ID is the unique identifier by which an activity that is performed in the context of a service offering is known in the billing system of the service provider</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestActivityIDInput[]</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestActivityIDInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>NoticeDate</maml:name> <maml:description> <maml:para>The last day on which the service provider organization can still be contacted to terminate the service level agreement (SLA) to ensure that it expires on the intended expiry date. The Notice date field is left empty, and the Expiry date field is filled out, when the SLA is to expire on a specific date and no notice needs to be given to terminate it.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of the organizations of the service level agreement. Only available for service level agreements where the coverage field is set to organizations_and_descendants, organizations or organizations_and_sites.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PersonIds</maml:name> <maml:description> <maml:para>Identifiers of the people of the service level agreement. Only available for service level agreements where the coverage field is set to people.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the service level agreement that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the service instance that will be used to provide the service to the customer of the service level agreement. Only service instances that are linked to the same service as the selected service offering can be selected.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceLevelManagerId</maml:name> <maml:description> <maml:para>Identifier of the person of the service provider organization who acts as the service level manager for the customer of the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SiteIds</maml:name> <maml:description> <maml:para>Identifiers of the sites of the service level agreement. Only available for service level agreements where the coverage field is set to sites or organizations_and_sites.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>Identifiers of the skill pools of the service level agreement. Only available for service level agreements where the coverage field is set to skill_pools.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The first day during which the service level agreement (SLA) is active.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the service level agreement (SLA).</maml:para> </maml:description> <command:parameterValue required="false">AgreementStatus</command:parameterValue> <dev:type> <maml:name>AgreementStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>UseKnowledgeFromServiceProvider</maml:name> <maml:description> <maml:para>Whether knowledge articles from the service provider should be exposed to the people covered by the service instances related to the service level agreement. Only available for service level agreements where the coverage field is set to service_instances.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="26"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service level agreement properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceLevelAgreementField[]</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization that pays for the service level agreement.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service level agreement.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ServiceOfferingId</maml:name> <maml:description> <maml:para>Identifier of the service offering that specifies the conditions that apply to the service level agreement.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ActivityID</maml:name> <maml:description> <maml:para>The Activity ID is the unique identifier by which an activity that is performed in the context of a service offering is known in the billing system of the service provider. This contains the activityIDs related to request categories.</maml:para> </maml:description> <command:parameterValue required="false">ActivityIDInput</command:parameterValue> <dev:type> <maml:name>ActivityIDInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AgreementID</maml:name> <maml:description> <maml:para>The Agreement ID is the unique identifier by which all the activities that are performed through the coverage of the SLA are known in the billing system of the service provider.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Coverage</maml:name> <maml:description> <maml:para>Used to specify how people who are to be covered by the service level agreement are to be selected.</maml:para> </maml:description> <command:parameterValue required="false">SlaCoverage</command:parameterValue> <dev:type> <maml:name>SlaCoverage</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomerAccountId</maml:name> <maml:description> <maml:para>Identifier of the account which service level managers are allowed to update the parts of the SLA that are intended to be maintained by the service level managers of the customer. More importantly, this field is used to specify whether specialists of the customer are allowed to see the requests that include this SLA in their Affected SLAs section.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomerRepresentativeIds</maml:name> <maml:description> <maml:para>Identifiers of the people who represents the customer organization for the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ExpiryDate</maml:name> <maml:description> <maml:para>The date through which the service level agreement (SLA) will be active. The SLA expires at the end of this day if it is not renewed before then. When the SLA has expired, its status will automatically be set to "Expired".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>NewEffortClassRateIDs</maml:name> <maml:description> <maml:para>The Rate IDs are the unique identifiers by which an effort class that is linked to a time entry when an activity was performed through the coverage of the SLA is known in the billing system of the service provider.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassRateIDInput[]</command:parameterValue> <dev:type> <maml:name>EffortClassRateIDInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>NewStandardServiceRequestActivityIDs</maml:name> <maml:description> <maml:para>Represents the activityIDs for standard service requests. The Activity ID is the unique identifier by which an activity that is performed in the context of a service offering is known in the billing system of the service provider</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestActivityIDInput[]</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestActivityIDInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>NoticeDate</maml:name> <maml:description> <maml:para>The last day on which the service provider organization can still be contacted to terminate the service level agreement (SLA) to ensure that it expires on the intended expiry date. The Notice date field is left empty, and the Expiry date field is filled out, when the SLA is to expire on a specific date and no notice needs to be given to terminate it.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of the organizations of the service level agreement. Only available for service level agreements where the coverage field is set to organizations_and_descendants, organizations or organizations_and_sites.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PersonIds</maml:name> <maml:description> <maml:para>Identifiers of the people of the service level agreement. Only available for service level agreements where the coverage field is set to people.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the service level agreement that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the service instance that will be used to provide the service to the customer of the service level agreement. Only service instances that are linked to the same service as the selected service offering can be selected.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceLevelManagerId</maml:name> <maml:description> <maml:para>Identifier of the person of the service provider organization who acts as the service level manager for the customer of the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SiteIds</maml:name> <maml:description> <maml:para>Identifiers of the sites of the service level agreement. Only available for service level agreements where the coverage field is set to sites or organizations_and_sites.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>Identifiers of the skill pools of the service level agreement. Only available for service level agreements where the coverage field is set to skill_pools.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The first day during which the service level agreement (SLA) is active.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the service level agreement (SLA).</maml:para> </maml:description> <command:parameterValue required="false">AgreementStatus</command:parameterValue> <dev:type> <maml:name>AgreementStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>UseKnowledgeFromServiceProvider</maml:name> <maml:description> <maml:para>Whether knowledge articles from the service provider should be exposed to the people covered by the service instances related to the service level agreement. Only available for service level agreements where the coverage field is set to service_instances.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="26"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service level agreement properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceLevelAgreementField[]</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ActivityIDInput</maml:name> </dev:type> <maml:description> <maml:para>An activity identifier input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaCoverage</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement coverage object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassRateIDInput[]</maml:name> </dev:type> <maml:description> <maml:para>An effort class rate identifier input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.StandardServiceRequestActivityIDInput[]</maml:name> </dev:type> <maml:description> <maml:para>A standard service request activity identifier input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgreementStatus</maml:name> </dev:type> <maml:description> <maml:para>An agreement status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementField[]</maml:name> </dev:type> <maml:description> <maml:para>The service level agreement field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceLevelAgreement</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceLevelAgreementQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceLevelAgreementQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a service level agreement query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentServiceLevelAgreementQuery cmdlet creates and configures a service level agreement query object using the provided parameters. These result can be used with the Invoke-XurrentServiceLevelAgreementQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceLevelAgreementQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the service level agreement query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service level agreement properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceLevelAgreementField[]</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementView</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementOrderField</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ActivityID</maml:name> <maml:description> <maml:para>Specify the activity ID details to be returned using an activity identifier query.</maml:para> </maml:description> <command:parameterValue required="false">ActivityIDQuery</command:parameterValue> <dev:type> <maml:name>ActivityIDQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CoverageGroups</maml:name> <maml:description> <maml:para>Specify the coverage groups details to be returned using a service level agreement coverage group query.</maml:para> </maml:description> <command:parameterValue required="false">SlaCoverageGroupQuery</command:parameterValue> <dev:type> <maml:name>SlaCoverageGroupQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Customer</maml:name> <maml:description> <maml:para>Specify the customer details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomerAccount</maml:name> <maml:description> <maml:para>Specify the customer account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomerRepresentatives</maml:name> <maml:description> <maml:para>Specify the customer representatives details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>EffortClassRateIDs</maml:name> <maml:description> <maml:para>Specify the effort class rate IDs details to be returned using an effort class rate identifier query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassRateIDQuery</command:parameterValue> <dev:type> <maml:name>EffortClassRateIDQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Invoices</maml:name> <maml:description> <maml:para>Specify the invoices details to be returned using an invoice query.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Organizations</maml:name> <maml:description> <maml:para>Specify the organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>People</maml:name> <maml:description> <maml:para>Specify the people details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a parent service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ParentServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ParentServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceLevelManager</maml:name> <maml:description> <maml:para>Specify the service level manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ServiceOffering</maml:name> <maml:description> <maml:para>Specify the service offering details to be returned using a service offering query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingQuery</command:parameterValue> <dev:type> <maml:name>ServiceOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Sites</maml:name> <maml:description> <maml:para>Specify the sites details to be returned using a site query.</maml:para> </maml:description> <command:parameterValue required="false">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SkillPools</maml:name> <maml:description> <maml:para>Specify the skill pools details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>StandardServiceRequestActivityIDs</maml:name> <maml:description> <maml:para>Specify the standard service request activity IDs details to be returned using a standard service request activity identifier query.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestActivityIDQuery</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestActivityIDQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>SupportDomain</maml:name> <maml:description> <maml:para>Specify the support domain details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ServiceLevelAgreementQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ServiceLevelAgreementQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ServiceLevelAgreementQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the service level agreement query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service level agreement properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceLevelAgreementField[]</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementView</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementOrderField</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ActivityID</maml:name> <maml:description> <maml:para>Specify the activity ID details to be returned using an activity identifier query.</maml:para> </maml:description> <command:parameterValue required="false">ActivityIDQuery</command:parameterValue> <dev:type> <maml:name>ActivityIDQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CoverageGroups</maml:name> <maml:description> <maml:para>Specify the coverage groups details to be returned using a service level agreement coverage group query.</maml:para> </maml:description> <command:parameterValue required="false">SlaCoverageGroupQuery</command:parameterValue> <dev:type> <maml:name>SlaCoverageGroupQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Customer</maml:name> <maml:description> <maml:para>Specify the customer details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomerAccount</maml:name> <maml:description> <maml:para>Specify the customer account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomerRepresentatives</maml:name> <maml:description> <maml:para>Specify the customer representatives details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>EffortClassRateIDs</maml:name> <maml:description> <maml:para>Specify the effort class rate IDs details to be returned using an effort class rate identifier query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassRateIDQuery</command:parameterValue> <dev:type> <maml:name>EffortClassRateIDQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Invoices</maml:name> <maml:description> <maml:para>Specify the invoices details to be returned using an invoice query.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Organizations</maml:name> <maml:description> <maml:para>Specify the organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>People</maml:name> <maml:description> <maml:para>Specify the people details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a parent service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ParentServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ParentServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceLevelManager</maml:name> <maml:description> <maml:para>Specify the service level manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ServiceOffering</maml:name> <maml:description> <maml:para>Specify the service offering details to be returned using a service offering query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingQuery</command:parameterValue> <dev:type> <maml:name>ServiceOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Sites</maml:name> <maml:description> <maml:para>Specify the sites details to be returned using a site query.</maml:para> </maml:description> <command:parameterValue required="false">SiteQuery</command:parameterValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SkillPools</maml:name> <maml:description> <maml:para>Specify the skill pools details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>StandardServiceRequestActivityIDs</maml:name> <maml:description> <maml:para>Specify the standard service request activity IDs details to be returned using a standard service request activity identifier query.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestActivityIDQuery</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestActivityIDQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>SupportDomain</maml:name> <maml:description> <maml:para>Specify the support domain details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ServiceLevelAgreementQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ServiceLevelAgreementQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ServiceLevelAgreementQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementField[]</maml:name> </dev:type> <maml:description> <maml:para>The Service level agreement field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementView</maml:name> </dev:type> <maml:description> <maml:para>The service level agreement view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementOrderField</maml:name> </dev:type> <maml:description> <maml:para>The service level agreement order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ActivityIDQuery</maml:name> </dev:type> <maml:description> <maml:para>An activity identifier query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaCoverageGroupQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement coverage group query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassRateIDQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class rate identifier query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InvoiceQuery</maml:name> </dev:type> <maml:description> <maml:para>An invoice query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ParentServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A parent service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>A service offering query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SiteQuery</maml:name> </dev:type> <maml:description> <maml:para>A site query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolQuery</maml:name> </dev:type> <maml:description> <maml:para>A skill pool query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.StandardServiceRequestActivityIDQuery</maml:name> </dev:type> <maml:description> <maml:para>A standard service request activity identifier query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ServiceLevelAgreementQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceLevelAgreementQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceLevelAgreementQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new service level agreement query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentServiceLevelAgreementQueryFilter cmdlet creates and configures a service level agreement query filter object using the provided parameters. These filters can be used with the New-XurrentServiceLevelAgreementQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceLevelAgreementQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ServiceLevelAgreementFilter</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ServiceLevelAgreementFilter</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementFilter</maml:name> </dev:type> <maml:description> <maml:para>a service level agreement filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ServiceLevelAgreementQuery></maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceOffering</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceOffering</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new service offering.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a service offering using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceOffering</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service offering.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the service offering is being prepared.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Availability</maml:name> <maml:description> <maml:para>The duration, expressed as percentage of the total number of service hours, during which the service is to be available to customers with an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Charges</maml:name> <maml:description> <maml:para>The amount that the service provider will charge the customer for the delivery of the service per charge driver, per charge term.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ChargeTypeCase</maml:name> <maml:description> <maml:para>Defines how a Case must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ChargeTypeHigh</maml:name> <maml:description> <maml:para>Defines how a high incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ChargeTypeLow</maml:name> <maml:description> <maml:para>Defines how a low incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ChargeTypeMedium</maml:name> <maml:description> <maml:para>Defines how a medium incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ChargeTypeRfc</maml:name> <maml:description> <maml:para>Defines how a RFC must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ChargeTypeRfi</maml:name> <maml:description> <maml:para>Defines how a RFI must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ChargeTypeTop</maml:name> <maml:description> <maml:para>Defines how a top incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Continuity</maml:name> <maml:description> <maml:para>The continuity measures for the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>DefaultEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a request with an affected SLA linked to this service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>EffortClassIds</maml:name> <maml:description> <maml:para>Identifiers of effort classes of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Limitations</maml:name> <maml:description> <maml:para>The limitations that apply to the service level agreements that are based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>NewEffortClassRates</maml:name> <maml:description> <maml:para>Effort class rates of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassRateInput[]</command:parameterValue> <dev:type> <maml:name>EffortClassRateInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>NewStandardServiceRequests</maml:name> <maml:description> <maml:para>Standard service requests of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestInput[]</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Penalties</maml:name> <maml:description> <maml:para>Used to specify what the penalties will be for the service provider organization if a service level target has been breached.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Performance</maml:name> <maml:description> <maml:para>Used to describe the transaction(s) and the maximum time these transaction(s) can take to complete.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Prerequisites</maml:name> <maml:description> <maml:para>Used to specify which requirements need to be met by the customer in order for the customer to be able to benefit from the service. The service provider cannot be held accountable for breaches of the service level targets caused by a failure of the customer to meet one or more of these prerequisites.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>RateCase</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a Case.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>RateCaseCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a Case.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>RateHigh</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a high incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>RateHighCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a high incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>RateLow</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a low incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>RateLowCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a low incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>RateMedium</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a medium incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>RateMediumCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a medium incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>RateRfc</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a RFC.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>RateRfcCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a RFC.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>RateRfi</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a RFI.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>RateRfiCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a RFI.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>RateTop</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a top incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>RateTopCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a top incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>RecoveryPointObjective</maml:name> <maml:description> <maml:para>The Recovery Point Objective (RPO) is the maximum targeted duration in minutes in which data (transactions) might be lost from an IT service due to a major incident.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>RecoveryTimeObjective</maml:name> <maml:description> <maml:para>The Recovery Time Objective (RTO) is the maximum targeted duration in minutes in which a business process must be restored after a disaster (or disruption) in order to avoid unacceptable consequences associated with a break in business continuity.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Reliability</maml:name> <maml:description> <maml:para>Used to specify the maximum number of times per month that the service may become unavailable to customers with an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>ReportFrequency</maml:name> <maml:description> <maml:para>Used to specify how often the representative of a customer of an active SLA that is based on the service offering will receive a report comparing the service level targets specified in the service offering with the actual level of service provided.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingReportFrequency</command:parameterValue> <dev:type> <maml:name>ServiceOfferingReportFrequency</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>ResolutionsWithinTarget</maml:name> <maml:description> <maml:para>The minimum percentage of incidents that is to be resolved before their resolution target.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>ResolutionTargetCase</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the category "Case" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>ResolutionTargetHigh</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "High - Service Degraded for Several Users" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>ResolutionTargetLow</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "Low - Service Degraded for One User" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>ResolutionTargetMedium</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "Medium - Service Down for One User" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>ResolutionTargetRfc</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the category "RFC - Request for Change" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>ResolutionTargetRfi</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the category "RFI - Request for Information" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="46"> <maml:name>ResolutionTargetTop</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "Top - Service Down for Several Users" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="47"> <maml:name>ResponsesWithinTarget</maml:name> <maml:description> <maml:para>The minimum percentage of incidents that is to be responded to before their response target.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="48"> <maml:name>ResponseTargetCase</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the category "Case" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="49"> <maml:name>ResponseTargetHigh</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "High - Service Degraded for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="50"> <maml:name>ResponseTargetLow</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "Low - Service Degraded for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="51"> <maml:name>ResponseTargetMedium</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "Medium - Service Down for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="52"> <maml:name>ResponseTargetRfc</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the category "RFC - Request for Change" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="53"> <maml:name>ResponseTargetRfi</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the category "RFI - Request for Information" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="54"> <maml:name>ResponseTargetTop</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "Top - Service Down for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="55"> <maml:name>ReviewFrequency</maml:name> <maml:description> <maml:para>How often an active SLA that is based on the service offering will be reviewed with the representative of its customer.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingReviewFrequency</command:parameterValue> <dev:type> <maml:name>ServiceOfferingReviewFrequency</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="56"> <maml:name>ServiceHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the hours during which the service is supposed to be available.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="57"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="58"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="59"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingStatus</command:parameterValue> <dev:type> <maml:name>ServiceOfferingStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="60"> <maml:name>Summary</maml:name> <maml:description> <maml:para>A high-level description of the differentiators between this service offering and other service offerings that have already been, or could be, prepared for the same service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="61"> <maml:name>SupportHoursCaseId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the category "Case" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="62"> <maml:name>SupportHoursHighId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "High - Service Degraded for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="63"> <maml:name>SupportHoursLowId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "Low - Service Degraded for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="64"> <maml:name>SupportHoursMediumId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "Medium - Service Down for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="65"> <maml:name>SupportHoursRfcId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the category "RFC - Request for Change" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="66"> <maml:name>SupportHoursRfiId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the category "RFI - Request for Information" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="67"> <maml:name>SupportHoursTopId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "Top - Service Down for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="68"> <maml:name>Termination</maml:name> <maml:description> <maml:para>Used to describe the length of notice required for changing or terminating the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="69"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected service hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="70"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service offering properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceOfferingField[]</command:parameterValue> <dev:type> <maml:name>ServiceOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="71"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service offering.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the service offering is being prepared.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Availability</maml:name> <maml:description> <maml:para>The duration, expressed as percentage of the total number of service hours, during which the service is to be available to customers with an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Charges</maml:name> <maml:description> <maml:para>The amount that the service provider will charge the customer for the delivery of the service per charge driver, per charge term.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ChargeTypeCase</maml:name> <maml:description> <maml:para>Defines how a Case must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ChargeTypeHigh</maml:name> <maml:description> <maml:para>Defines how a high incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ChargeTypeLow</maml:name> <maml:description> <maml:para>Defines how a low incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ChargeTypeMedium</maml:name> <maml:description> <maml:para>Defines how a medium incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ChargeTypeRfc</maml:name> <maml:description> <maml:para>Defines how a RFC must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ChargeTypeRfi</maml:name> <maml:description> <maml:para>Defines how a RFI must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ChargeTypeTop</maml:name> <maml:description> <maml:para>Defines how a top incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Continuity</maml:name> <maml:description> <maml:para>The continuity measures for the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>DefaultEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a request with an affected SLA linked to this service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>EffortClassIds</maml:name> <maml:description> <maml:para>Identifiers of effort classes of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Limitations</maml:name> <maml:description> <maml:para>The limitations that apply to the service level agreements that are based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>NewEffortClassRates</maml:name> <maml:description> <maml:para>Effort class rates of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassRateInput[]</command:parameterValue> <dev:type> <maml:name>EffortClassRateInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>NewStandardServiceRequests</maml:name> <maml:description> <maml:para>Standard service requests of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestInput[]</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Penalties</maml:name> <maml:description> <maml:para>Used to specify what the penalties will be for the service provider organization if a service level target has been breached.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Performance</maml:name> <maml:description> <maml:para>Used to describe the transaction(s) and the maximum time these transaction(s) can take to complete.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Prerequisites</maml:name> <maml:description> <maml:para>Used to specify which requirements need to be met by the customer in order for the customer to be able to benefit from the service. The service provider cannot be held accountable for breaches of the service level targets caused by a failure of the customer to meet one or more of these prerequisites.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>RateCase</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a Case.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>RateCaseCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a Case.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>RateHigh</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a high incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>RateHighCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a high incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>RateLow</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a low incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>RateLowCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a low incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>RateMedium</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a medium incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>RateMediumCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a medium incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>RateRfc</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a RFC.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>RateRfcCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a RFC.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>RateRfi</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a RFI.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>RateRfiCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a RFI.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>RateTop</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a top incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>RateTopCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a top incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>RecoveryPointObjective</maml:name> <maml:description> <maml:para>The Recovery Point Objective (RPO) is the maximum targeted duration in minutes in which data (transactions) might be lost from an IT service due to a major incident.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>RecoveryTimeObjective</maml:name> <maml:description> <maml:para>The Recovery Time Objective (RTO) is the maximum targeted duration in minutes in which a business process must be restored after a disaster (or disruption) in order to avoid unacceptable consequences associated with a break in business continuity.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Reliability</maml:name> <maml:description> <maml:para>Used to specify the maximum number of times per month that the service may become unavailable to customers with an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>ReportFrequency</maml:name> <maml:description> <maml:para>Used to specify how often the representative of a customer of an active SLA that is based on the service offering will receive a report comparing the service level targets specified in the service offering with the actual level of service provided.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingReportFrequency</command:parameterValue> <dev:type> <maml:name>ServiceOfferingReportFrequency</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>ResolutionsWithinTarget</maml:name> <maml:description> <maml:para>The minimum percentage of incidents that is to be resolved before their resolution target.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>ResolutionTargetCase</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the category "Case" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>ResolutionTargetHigh</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "High - Service Degraded for Several Users" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>ResolutionTargetLow</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "Low - Service Degraded for One User" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>ResolutionTargetMedium</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "Medium - Service Down for One User" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>ResolutionTargetRfc</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the category "RFC - Request for Change" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>ResolutionTargetRfi</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the category "RFI - Request for Information" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="46"> <maml:name>ResolutionTargetTop</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "Top - Service Down for Several Users" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="47"> <maml:name>ResponsesWithinTarget</maml:name> <maml:description> <maml:para>The minimum percentage of incidents that is to be responded to before their response target.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="48"> <maml:name>ResponseTargetCase</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the category "Case" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="49"> <maml:name>ResponseTargetHigh</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "High - Service Degraded for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="50"> <maml:name>ResponseTargetLow</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "Low - Service Degraded for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="51"> <maml:name>ResponseTargetMedium</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "Medium - Service Down for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="52"> <maml:name>ResponseTargetRfc</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the category "RFC - Request for Change" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="53"> <maml:name>ResponseTargetRfi</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the category "RFI - Request for Information" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="54"> <maml:name>ResponseTargetTop</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "Top - Service Down for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="55"> <maml:name>ReviewFrequency</maml:name> <maml:description> <maml:para>How often an active SLA that is based on the service offering will be reviewed with the representative of its customer.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingReviewFrequency</command:parameterValue> <dev:type> <maml:name>ServiceOfferingReviewFrequency</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="56"> <maml:name>ServiceHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the hours during which the service is supposed to be available.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="57"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="58"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="59"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingStatus</command:parameterValue> <dev:type> <maml:name>ServiceOfferingStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="60"> <maml:name>Summary</maml:name> <maml:description> <maml:para>A high-level description of the differentiators between this service offering and other service offerings that have already been, or could be, prepared for the same service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="61"> <maml:name>SupportHoursCaseId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the category "Case" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="62"> <maml:name>SupportHoursHighId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "High - Service Degraded for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="63"> <maml:name>SupportHoursLowId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "Low - Service Degraded for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="64"> <maml:name>SupportHoursMediumId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "Medium - Service Down for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="65"> <maml:name>SupportHoursRfcId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the category "RFC - Request for Change" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="66"> <maml:name>SupportHoursRfiId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the category "RFI - Request for Information" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="67"> <maml:name>SupportHoursTopId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "Top - Service Down for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="68"> <maml:name>Termination</maml:name> <maml:description> <maml:para>Used to describe the length of notice required for changing or terminating the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="69"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected service hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="70"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service offering properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceOfferingField[]</command:parameterValue> <dev:type> <maml:name>ServiceOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="71"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingChargeType</maml:name> </dev:type> <maml:description> <maml:para>A service offering charge type object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassRateInput[]</maml:name> </dev:type> <maml:description> <maml:para>An effort class rate input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.StandardServiceRequestInput[]</maml:name> </dev:type> <maml:description> <maml:para>A standard service request input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingReportFrequency</maml:name> </dev:type> <maml:description> <maml:para>A service offering report frequency object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingReviewFrequency</maml:name> </dev:type> <maml:description> <maml:para>A service offering review frequency object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingStatus</maml:name> </dev:type> <maml:description> <maml:para>A service offering status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingField[]</maml:name> </dev:type> <maml:description> <maml:para>The service offering field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceOffering</maml:name> </dev:type> <maml:description> <maml:para>A service offering object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceOfferingQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceOfferingQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a service offering query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentServiceOfferingQuery cmdlet creates and configures a service offering query object using the provided parameters. These result can be used with the Invoke-XurrentServiceOfferingQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceOfferingQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the service offering query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service offering properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceOfferingField[]</command:parameterValue> <dev:type> <maml:name>ServiceOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingView</command:parameterValue> <dev:type> <maml:name>ServiceOfferingView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingOrderField</command:parameterValue> <dev:type> <maml:name>ServiceOfferingOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ChargesAttachments</maml:name> <maml:description> <maml:para>Specify the charges attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ContinuityAttachments</maml:name> <maml:description> <maml:para>Specify the continuity attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DefaultEffortClass</maml:name> <maml:description> <maml:para>Specify the default effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EffortClasses</maml:name> <maml:description> <maml:para>Specify the effort classes details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>EffortClassRates</maml:name> <maml:description> <maml:para>Specify the effort class rates details to be returned using an effort class rate query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassRateQuery</command:parameterValue> <dev:type> <maml:name>EffortClassRateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>LimitationsAttachments</maml:name> <maml:description> <maml:para>Specify the limitations attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PenaltiesAttachments</maml:name> <maml:description> <maml:para>Specify the penalties attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PerformanceAttachments</maml:name> <maml:description> <maml:para>Specify the performance attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PrerequisitesAttachments</maml:name> <maml:description> <maml:para>Specify the prerequisites attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ResolutionTargetNotificationSchemeHigh</maml:name> <maml:description> <maml:para>Specify the resolution target notification scheme high details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ResolutionTargetNotificationSchemeLow</maml:name> <maml:description> <maml:para>Specify the resolution target notification scheme low details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ResolutionTargetNotificationSchemeMedium</maml:name> <maml:description> <maml:para>Specify the resolution target notification scheme medium details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ResolutionTargetNotificationSchemeTop</maml:name> <maml:description> <maml:para>Specify the resolution target notification scheme top details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ResponseTargetNotificationSchemeHigh</maml:name> <maml:description> <maml:para>Specify the response target notification scheme high details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>ResponseTargetNotificationSchemeLow</maml:name> <maml:description> <maml:para>Specify the response target notification scheme low details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>ResponseTargetNotificationSchemeMedium</maml:name> <maml:description> <maml:para>Specify the response target notification scheme medium details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>ResponseTargetNotificationSchemeTop</maml:name> <maml:description> <maml:para>Specify the response target notification scheme top details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>ServiceHours</maml:name> <maml:description> <maml:para>Specify the service hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>ServiceLevelAgreements</maml:name> <maml:description> <maml:para>Specify the service level agreements details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>ShopArticles</maml:name> <maml:description> <maml:para>Specify the shop articles details to be returned using a shop article query.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>StandardServiceRequests</maml:name> <maml:description> <maml:para>Specify the standard service requests details to be returned using a standard service request query.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestQuery</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>SummaryAttachments</maml:name> <maml:description> <maml:para>Specify the summary attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>SupportHoursCase</maml:name> <maml:description> <maml:para>Specify the support hours case details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>SupportHoursHigh</maml:name> <maml:description> <maml:para>Specify the support hours high details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SupportHoursLow</maml:name> <maml:description> <maml:para>Specify the support hours low details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>SupportHoursMedium</maml:name> <maml:description> <maml:para>Specify the support hours medium details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SupportHoursRfc</maml:name> <maml:description> <maml:para>Specify the support hours RFC details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>SupportHoursRfi</maml:name> <maml:description> <maml:para>Specify the support hours RFI details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>SupportHoursTop</maml:name> <maml:description> <maml:para>Specify the support hours top details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>TerminationAttachments</maml:name> <maml:description> <maml:para>Specify the termination attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>WaitingForCustomerFollowUp</maml:name> <maml:description> <maml:para>Specify the waiting for customer follow up details to be returned using a waiting for customer follow up query.</maml:para> </maml:description> <command:parameterValue required="false">WaitingForCustomerFollowUpQuery</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerFollowUpQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ServiceOfferingQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ServiceOfferingQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ServiceOfferingQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the service offering query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service offering properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceOfferingField[]</command:parameterValue> <dev:type> <maml:name>ServiceOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingView</command:parameterValue> <dev:type> <maml:name>ServiceOfferingView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingOrderField</command:parameterValue> <dev:type> <maml:name>ServiceOfferingOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ChargesAttachments</maml:name> <maml:description> <maml:para>Specify the charges attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ContinuityAttachments</maml:name> <maml:description> <maml:para>Specify the continuity attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DefaultEffortClass</maml:name> <maml:description> <maml:para>Specify the default effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EffortClasses</maml:name> <maml:description> <maml:para>Specify the effort classes details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>EffortClassRates</maml:name> <maml:description> <maml:para>Specify the effort class rates details to be returned using an effort class rate query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassRateQuery</command:parameterValue> <dev:type> <maml:name>EffortClassRateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>LimitationsAttachments</maml:name> <maml:description> <maml:para>Specify the limitations attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PenaltiesAttachments</maml:name> <maml:description> <maml:para>Specify the penalties attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PerformanceAttachments</maml:name> <maml:description> <maml:para>Specify the performance attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PrerequisitesAttachments</maml:name> <maml:description> <maml:para>Specify the prerequisites attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ResolutionTargetNotificationSchemeHigh</maml:name> <maml:description> <maml:para>Specify the resolution target notification scheme high details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ResolutionTargetNotificationSchemeLow</maml:name> <maml:description> <maml:para>Specify the resolution target notification scheme low details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ResolutionTargetNotificationSchemeMedium</maml:name> <maml:description> <maml:para>Specify the resolution target notification scheme medium details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ResolutionTargetNotificationSchemeTop</maml:name> <maml:description> <maml:para>Specify the resolution target notification scheme top details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ResponseTargetNotificationSchemeHigh</maml:name> <maml:description> <maml:para>Specify the response target notification scheme high details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>ResponseTargetNotificationSchemeLow</maml:name> <maml:description> <maml:para>Specify the response target notification scheme low details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>ResponseTargetNotificationSchemeMedium</maml:name> <maml:description> <maml:para>Specify the response target notification scheme medium details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>ResponseTargetNotificationSchemeTop</maml:name> <maml:description> <maml:para>Specify the response target notification scheme top details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>ServiceHours</maml:name> <maml:description> <maml:para>Specify the service hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>ServiceLevelAgreements</maml:name> <maml:description> <maml:para>Specify the service level agreements details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>ShopArticles</maml:name> <maml:description> <maml:para>Specify the shop articles details to be returned using a shop article query.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>StandardServiceRequests</maml:name> <maml:description> <maml:para>Specify the standard service requests details to be returned using a standard service request query.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestQuery</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>SummaryAttachments</maml:name> <maml:description> <maml:para>Specify the summary attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>SupportHoursCase</maml:name> <maml:description> <maml:para>Specify the support hours case details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>SupportHoursHigh</maml:name> <maml:description> <maml:para>Specify the support hours high details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SupportHoursLow</maml:name> <maml:description> <maml:para>Specify the support hours low details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>SupportHoursMedium</maml:name> <maml:description> <maml:para>Specify the support hours medium details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SupportHoursRfc</maml:name> <maml:description> <maml:para>Specify the support hours RFC details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>SupportHoursRfi</maml:name> <maml:description> <maml:para>Specify the support hours RFI details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>SupportHoursTop</maml:name> <maml:description> <maml:para>Specify the support hours top details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>TerminationAttachments</maml:name> <maml:description> <maml:para>Specify the termination attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>WaitingForCustomerFollowUp</maml:name> <maml:description> <maml:para>Specify the waiting for customer follow up details to be returned using a waiting for customer follow up query.</maml:para> </maml:description> <command:parameterValue required="false">WaitingForCustomerFollowUpQuery</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerFollowUpQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ServiceOfferingQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ServiceOfferingQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ServiceOfferingQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingField[]</maml:name> </dev:type> <maml:description> <maml:para>The Service offering field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingView</maml:name> </dev:type> <maml:description> <maml:para>The service offering view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingOrderField</maml:name> </dev:type> <maml:description> <maml:para>The service offering order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassRateQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class rate query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaNotificationSchemeQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement notification scheme query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop article query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.StandardServiceRequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A standard service request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WaitingForCustomerFollowUpQuery</maml:name> </dev:type> <maml:description> <maml:para>A waiting for customer follow up query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ServiceOfferingQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A service offering query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>A service offering query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceOfferingQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceOfferingQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new service offering query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentServiceOfferingQueryFilter cmdlet creates and configures a service offering query filter object using the provided parameters. These filters can be used with the New-XurrentServiceOfferingQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceOfferingQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ServiceOfferingFilter</command:parameterValue> <dev:type> <maml:name>ServiceOfferingFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ServiceOfferingFilter</command:parameterValue> <dev:type> <maml:name>ServiceOfferingFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingFilter</maml:name> </dev:type> <maml:description> <maml:para>a service offering filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ServiceOfferingQuery></maml:name> </dev:type> <maml:description> <maml:para>A service offering query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a service query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentServiceQuery cmdlet creates and configures a service query object using the provided parameters. These result can be used with the Invoke-XurrentServiceQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the service query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceField[]</command:parameterValue> <dev:type> <maml:name>ServiceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceView</command:parameterValue> <dev:type> <maml:name>ServiceView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOrderField</command:parameterValue> <dev:type> <maml:name>ServiceOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AvailabilityManager</maml:name> <maml:description> <maml:para>Specify the availability manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CapacityManager</maml:name> <maml:description> <maml:para>Specify the capacity manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ChangeManager</maml:name> <maml:description> <maml:para>Specify the change manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ContinuityManager</maml:name> <maml:description> <maml:para>Specify the continuity manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>FirstLineTeam</maml:name> <maml:description> <maml:para>Specify the first line team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>KnowledgeManager</maml:name> <maml:description> <maml:para>Specify the knowledge manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProblemManager</maml:name> <maml:description> <maml:para>Specify the problem manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ReleaseManager</maml:name> <maml:description> <maml:para>Specify the release manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceLevelAgreements</maml:name> <maml:description> <maml:para>Specify the service level agreements details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ServiceOfferings</maml:name> <maml:description> <maml:para>Specify the service offerings details to be returned using a service offering query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingQuery</command:parameterValue> <dev:type> <maml:name>ServiceOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>ServiceOwner</maml:name> <maml:description> <maml:para>Specify the service owner details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>ServiceProvider</maml:name> <maml:description> <maml:para>Specify the service provider details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>SupportTeam</maml:name> <maml:description> <maml:para>Specify the support team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Survey</maml:name> <maml:description> <maml:para>Specify the survey details to be returned using a survey query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ServiceQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ServiceQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ServiceQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the service query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceField[]</command:parameterValue> <dev:type> <maml:name>ServiceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceView</command:parameterValue> <dev:type> <maml:name>ServiceView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOrderField</command:parameterValue> <dev:type> <maml:name>ServiceOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AvailabilityManager</maml:name> <maml:description> <maml:para>Specify the availability manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CapacityManager</maml:name> <maml:description> <maml:para>Specify the capacity manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ChangeManager</maml:name> <maml:description> <maml:para>Specify the change manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ContinuityManager</maml:name> <maml:description> <maml:para>Specify the continuity manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>FirstLineTeam</maml:name> <maml:description> <maml:para>Specify the first line team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>KnowledgeManager</maml:name> <maml:description> <maml:para>Specify the knowledge manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProblemManager</maml:name> <maml:description> <maml:para>Specify the problem manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ReleaseManager</maml:name> <maml:description> <maml:para>Specify the release manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceLevelAgreements</maml:name> <maml:description> <maml:para>Specify the service level agreements details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ServiceOfferings</maml:name> <maml:description> <maml:para>Specify the service offerings details to be returned using a service offering query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingQuery</command:parameterValue> <dev:type> <maml:name>ServiceOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>ServiceOwner</maml:name> <maml:description> <maml:para>Specify the service owner details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>ServiceProvider</maml:name> <maml:description> <maml:para>Specify the service provider details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>SupportTeam</maml:name> <maml:description> <maml:para>Specify the support team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Survey</maml:name> <maml:description> <maml:para>Specify the survey details to be returned using a survey query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ServiceQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ServiceQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ServiceQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceField[]</maml:name> </dev:type> <maml:description> <maml:para>The Service field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceView</maml:name> </dev:type> <maml:description> <maml:para>The service view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOrderField</maml:name> </dev:type> <maml:description> <maml:para>The service order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>A service offering query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ServiceQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A service query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentServiceQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentServiceQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new service query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentServiceQueryFilter cmdlet creates and configures a service query filter object using the provided parameters. These filters can be used with the New-XurrentServiceQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentServiceQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ServiceFilter</command:parameterValue> <dev:type> <maml:name>ServiceFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ServiceFilter</command:parameterValue> <dev:type> <maml:name>ServiceFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceFilter</maml:name> </dev:type> <maml:description> <maml:para>a service filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ServiceQuery></maml:name> </dev:type> <maml:description> <maml:para>A service query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentShopArticle</command:name> <command:verb>New</command:verb> <command:noun>XurrentShopArticle</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new shop article.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a shop article using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentShopArticle</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The display name of the shop article.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CalendarId</maml:name> <maml:description> <maml:para>Calendar that represents the work hours related to the fulfillment/delivery.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DeliveryDuration</maml:name> <maml:description> <maml:para>The number of minutes it usually takes to deliver the shop article.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the shop article is visible in the shop.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>After this moment the shop article is no longer available in the shop.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>FulfillmentTemplateId</maml:name> <maml:description> <maml:para>The request template used to order one of more units of this shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>FullDescription</maml:name> <maml:description> <maml:para>The full description of the shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaxQuantity</maml:name> <maml:description> <maml:para>The largest number of units that may be bought at once.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Price</maml:name> <maml:description> <maml:para>The price of a single unit.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>PriceCurrency</maml:name> <maml:description> <maml:para>The currency of the price of this shop article.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Related product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>RecurringPeriod</maml:name> <maml:description> <maml:para>The frequency in which the recurring price is due.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleRecurringPeriod</command:parameterValue> <dev:type> <maml:name>ShopArticleRecurringPeriod</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RecurringPrice</maml:name> <maml:description> <maml:para>The recurring price of a single unit.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RecurringPriceCurrency</maml:name> <maml:description> <maml:para>The currency of the recurring price of this shop article.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Reference</maml:name> <maml:description> <maml:para>This reference can be used to link the shop article to a shop order line using the Xurrent APIs or the Xurrent Import functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>RequiresShipping</maml:name> <maml:description> <maml:para>Whether or not this is a physical article that requires shipping.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ShortDescription</maml:name> <maml:description> <maml:para>The shop description of the shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The moment the shop article becomes available in the shop.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The Time zone related to the calendar.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="24"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of shop article properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopArticleField[]</command:parameterValue> <dev:type> <maml:name>ShopArticleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The display name of the shop article.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CalendarId</maml:name> <maml:description> <maml:para>Calendar that represents the work hours related to the fulfillment/delivery.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DeliveryDuration</maml:name> <maml:description> <maml:para>The number of minutes it usually takes to deliver the shop article.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the shop article is visible in the shop.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>After this moment the shop article is no longer available in the shop.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>FulfillmentTemplateId</maml:name> <maml:description> <maml:para>The request template used to order one of more units of this shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>FullDescription</maml:name> <maml:description> <maml:para>The full description of the shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaxQuantity</maml:name> <maml:description> <maml:para>The largest number of units that may be bought at once.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Price</maml:name> <maml:description> <maml:para>The price of a single unit.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>PriceCurrency</maml:name> <maml:description> <maml:para>The currency of the price of this shop article.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Related product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>RecurringPeriod</maml:name> <maml:description> <maml:para>The frequency in which the recurring price is due.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleRecurringPeriod</command:parameterValue> <dev:type> <maml:name>ShopArticleRecurringPeriod</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RecurringPrice</maml:name> <maml:description> <maml:para>The recurring price of a single unit.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RecurringPriceCurrency</maml:name> <maml:description> <maml:para>The currency of the recurring price of this shop article.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Reference</maml:name> <maml:description> <maml:para>This reference can be used to link the shop article to a shop order line using the Xurrent APIs or the Xurrent Import functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>RequiresShipping</maml:name> <maml:description> <maml:para>Whether or not this is a physical article that requires shipping.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ShortDescription</maml:name> <maml:description> <maml:para>The shop description of the shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The moment the shop article becomes available in the shop.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The Time zone related to the calendar.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="24"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of shop article properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopArticleField[]</command:parameterValue> <dev:type> <maml:name>ShopArticleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleRecurringPeriod</maml:name> </dev:type> <maml:description> <maml:para>A shop article recurring period object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleField[]</maml:name> </dev:type> <maml:description> <maml:para>The shop article field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShopArticle</maml:name> </dev:type> <maml:description> <maml:para>A shop article object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentShopArticleCategory</command:name> <command:verb>New</command:verb> <command:noun>XurrentShopArticleCategory</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new shop article category.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a shop article category using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentShopArticleCategory</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The display name of the shop article category.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>FullDescription</maml:name> <maml:description> <maml:para>The full description of the shop article category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>FullDescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the fullDescription field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ParentId</maml:name> <maml:description> <maml:para>Identifier of the category's parent category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ShortDescription</maml:name> <maml:description> <maml:para>The shop description of the shop article category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of shop article category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopArticleCategoryField[]</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The display name of the shop article category.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>FullDescription</maml:name> <maml:description> <maml:para>The full description of the shop article category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>FullDescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the fullDescription field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ParentId</maml:name> <maml:description> <maml:para>Identifier of the category's parent category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ShortDescription</maml:name> <maml:description> <maml:para>The shop description of the shop article category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of shop article category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopArticleCategoryField[]</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleCategoryField[]</maml:name> </dev:type> <maml:description> <maml:para>The shop article category field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShopArticleCategory</maml:name> </dev:type> <maml:description> <maml:para>A shop article category object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentShopArticleCategoryQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentShopArticleCategoryQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a shop article category query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentShopArticleCategoryQuery cmdlet creates and configures a shop article category query object using the provided parameters. These result can be used with the Invoke-XurrentShopArticleCategoryQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentShopArticleCategoryQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the shop article category query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a shop article category properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopArticleCategoryField[]</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleCategoryView</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleCategoryOrderField</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>FullDescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the full description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Parent</maml:name> <maml:description> <maml:para>Specify the parent details to be returned using a shop article category query.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleCategoryQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ShopArticleCategoryQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ShopArticleCategoryQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ShopArticleCategoryQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the shop article category query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a shop article category properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopArticleCategoryField[]</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleCategoryView</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleCategoryOrderField</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>FullDescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the full description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Parent</maml:name> <maml:description> <maml:para>Specify the parent details to be returned using a shop article category query.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleCategoryQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ShopArticleCategoryQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ShopArticleCategoryQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ShopArticleCategoryQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleCategoryField[]</maml:name> </dev:type> <maml:description> <maml:para>The Shop article category field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleCategoryView</maml:name> </dev:type> <maml:description> <maml:para>The shop article category view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleCategoryOrderField</maml:name> </dev:type> <maml:description> <maml:para>The shop article category order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop article category query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ShopArticleCategoryQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A shop article category query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShopArticleCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop article category query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentShopArticleCategoryQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentShopArticleCategoryQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new shop article category query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentShopArticleCategoryQueryFilter cmdlet creates and configures a shop article category query filter object using the provided parameters. These filters can be used with the New-XurrentShopArticleCategoryQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentShopArticleCategoryQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ShopArticleCategoryFilter</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ShopArticleCategoryFilter</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleCategoryFilter</maml:name> </dev:type> <maml:description> <maml:para>a shop article category filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ShopArticleCategoryQuery></maml:name> </dev:type> <maml:description> <maml:para>A shop article category query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentShopArticleQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentShopArticleQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a shop article query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentShopArticleQuery cmdlet creates and configures a shop article query object using the provided parameters. These result can be used with the Invoke-XurrentShopArticleQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentShopArticleQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the shop article query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a shop article properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopArticleField[]</command:parameterValue> <dev:type> <maml:name>ShopArticleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleView</command:parameterValue> <dev:type> <maml:name>ShopArticleView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleOrderField</command:parameterValue> <dev:type> <maml:name>ShopArticleOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Calendar</maml:name> <maml:description> <maml:para>Specify the calendar details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Category</maml:name> <maml:description> <maml:para>Specify the category details to be returned using a shop article category query.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleCategoryQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>FulfillmentTemplate</maml:name> <maml:description> <maml:para>Specify the fulfillment template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Product</maml:name> <maml:description> <maml:para>Specify the product details to be returned using a product query.</maml:para> </maml:description> <command:parameterValue required="false">ProductQuery</command:parameterValue> <dev:type> <maml:name>ProductQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ProviderShopArticle</maml:name> <maml:description> <maml:para>Specify the provider shop article details to be returned using a provider shop article query.</maml:para> </maml:description> <command:parameterValue required="false">ProviderShopArticleQuery</command:parameterValue> <dev:type> <maml:name>ProviderShopArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ShopArticleQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ShopArticleQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ShopArticleQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the shop article query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a shop article properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopArticleField[]</command:parameterValue> <dev:type> <maml:name>ShopArticleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleView</command:parameterValue> <dev:type> <maml:name>ShopArticleView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleOrderField</command:parameterValue> <dev:type> <maml:name>ShopArticleOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Calendar</maml:name> <maml:description> <maml:para>Specify the calendar details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Category</maml:name> <maml:description> <maml:para>Specify the category details to be returned using a shop article category query.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleCategoryQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>FulfillmentTemplate</maml:name> <maml:description> <maml:para>Specify the fulfillment template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Product</maml:name> <maml:description> <maml:para>Specify the product details to be returned using a product query.</maml:para> </maml:description> <command:parameterValue required="false">ProductQuery</command:parameterValue> <dev:type> <maml:name>ProductQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ProviderShopArticle</maml:name> <maml:description> <maml:para>Specify the provider shop article details to be returned using a provider shop article query.</maml:para> </maml:description> <command:parameterValue required="false">ProviderShopArticleQuery</command:parameterValue> <dev:type> <maml:name>ProviderShopArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ShopArticleQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ShopArticleQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ShopArticleQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleField[]</maml:name> </dev:type> <maml:description> <maml:para>The Shop article field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleView</maml:name> </dev:type> <maml:description> <maml:para>The shop article view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleOrderField</maml:name> </dev:type> <maml:description> <maml:para>The shop article order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop article category query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A request template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductQuery</maml:name> </dev:type> <maml:description> <maml:para>A product query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProviderShopArticleQuery</maml:name> </dev:type> <maml:description> <maml:para>A provider shop article query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ShopArticleQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A shop article query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShopArticleQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop article query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentShopArticleQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentShopArticleQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new shop article query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentShopArticleQueryFilter cmdlet creates and configures a shop article query filter object using the provided parameters. These filters can be used with the New-XurrentShopArticleQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentShopArticleQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ShopArticleFilter</command:parameterValue> <dev:type> <maml:name>ShopArticleFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ShopArticleFilter</command:parameterValue> <dev:type> <maml:name>ShopArticleFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleFilter</maml:name> </dev:type> <maml:description> <maml:para>a shop article filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ShopArticleQuery></maml:name> </dev:type> <maml:description> <maml:para>A shop article query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentShopOrderLine</command:name> <command:verb>New</command:verb> <command:noun>XurrentShopOrderLine</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new shop order line.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a shop order line using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentShopOrderLine</maml:name> <command:parameter required="true" position="0"> <maml:name>Quantity</maml:name> <maml:description> <maml:para>The number units ordered.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>RequestedForId</maml:name> <maml:description> <maml:para>The person for whom the shop order line was submitted.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ShopArticleId</maml:name> <maml:description> <maml:para>The shop article that is ordered.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of the shop order line.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of shop order line properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopOrderLineField[]</command:parameterValue> <dev:type> <maml:name>ShopOrderLineField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Quantity</maml:name> <maml:description> <maml:para>The number units ordered.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>RequestedForId</maml:name> <maml:description> <maml:para>The person for whom the shop order line was submitted.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ShopArticleId</maml:name> <maml:description> <maml:para>The shop article that is ordered.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of the shop order line.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of shop order line properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopOrderLineField[]</command:parameterValue> <dev:type> <maml:name>ShopOrderLineField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressInput[]</maml:name> </dev:type> <maml:description> <maml:para>An address input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopOrderLineField[]</maml:name> </dev:type> <maml:description> <maml:para>The shop order line field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShopOrderLine</maml:name> </dev:type> <maml:description> <maml:para>A shop order line object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentShopOrderLineQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentShopOrderLineQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a shop order line query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentShopOrderLineQuery cmdlet creates and configures a shop order line query object using the provided parameters. These result can be used with the Invoke-XurrentShopOrderLineQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentShopOrderLineQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the shop order line query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a shop order line properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopOrderLineField[]</command:parameterValue> <dev:type> <maml:name>ShopOrderLineField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShopOrderLineView</command:parameterValue> <dev:type> <maml:name>ShopOrderLineView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShopOrderLineOrderField</command:parameterValue> <dev:type> <maml:name>ShopOrderLineOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Addresses</maml:name> <maml:description> <maml:para>Specify the addresses details to be returned using an address query.</maml:para> </maml:description> <command:parameterValue required="false">AddressQuery</command:parameterValue> <dev:type> <maml:name>AddressQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>FulfillmentRequest</maml:name> <maml:description> <maml:para>Specify the fulfillment request details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FulfillmentTask</maml:name> <maml:description> <maml:para>Specify the fulfillment task details to be returned using a task query.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>FulfillmentTemplate</maml:name> <maml:description> <maml:para>Specify the fulfillment template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Order</maml:name> <maml:description> <maml:para>Specify the order details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ProviderOrderLine</maml:name> <maml:description> <maml:para>Specify the provider order line details to be returned using a provider shop order line query.</maml:para> </maml:description> <command:parameterValue required="false">ProviderShopOrderLineQuery</command:parameterValue> <dev:type> <maml:name>ProviderShopOrderLineQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RequestedBy</maml:name> <maml:description> <maml:para>Specify the requested by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RequestedFor</maml:name> <maml:description> <maml:para>Specify the requested for details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ShopArticle</maml:name> <maml:description> <maml:para>Specify the shop article details to be returned using a shop article query.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ShopOrderLineQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ShopOrderLineQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ShopOrderLineQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the shop order line query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a shop order line properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopOrderLineField[]</command:parameterValue> <dev:type> <maml:name>ShopOrderLineField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShopOrderLineView</command:parameterValue> <dev:type> <maml:name>ShopOrderLineView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShopOrderLineOrderField</command:parameterValue> <dev:type> <maml:name>ShopOrderLineOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Addresses</maml:name> <maml:description> <maml:para>Specify the addresses details to be returned using an address query.</maml:para> </maml:description> <command:parameterValue required="false">AddressQuery</command:parameterValue> <dev:type> <maml:name>AddressQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>FulfillmentRequest</maml:name> <maml:description> <maml:para>Specify the fulfillment request details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FulfillmentTask</maml:name> <maml:description> <maml:para>Specify the fulfillment task details to be returned using a task query.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>FulfillmentTemplate</maml:name> <maml:description> <maml:para>Specify the fulfillment template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Order</maml:name> <maml:description> <maml:para>Specify the order details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ProviderOrderLine</maml:name> <maml:description> <maml:para>Specify the provider order line details to be returned using a provider shop order line query.</maml:para> </maml:description> <command:parameterValue required="false">ProviderShopOrderLineQuery</command:parameterValue> <dev:type> <maml:name>ProviderShopOrderLineQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RequestedBy</maml:name> <maml:description> <maml:para>Specify the requested by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RequestedFor</maml:name> <maml:description> <maml:para>Specify the requested for details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ShopArticle</maml:name> <maml:description> <maml:para>Specify the shop article details to be returned using a shop article query.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ShopOrderLineQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ShopOrderLineQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ShopOrderLineQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopOrderLineField[]</maml:name> </dev:type> <maml:description> <maml:para>The Shop order line field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopOrderLineView</maml:name> </dev:type> <maml:description> <maml:para>The shop order line view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopOrderLineOrderField</maml:name> </dev:type> <maml:description> <maml:para>The shop order line order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressQuery</maml:name> </dev:type> <maml:description> <maml:para>An address query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A request template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProviderShopOrderLineQuery</maml:name> </dev:type> <maml:description> <maml:para>A provider shop order line query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop article query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ShopOrderLineQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A shop order line query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShopOrderLineQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop order line query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentShopOrderLineQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentShopOrderLineQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new shop order line query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentShopOrderLineQueryFilter cmdlet creates and configures a shop order line query filter object using the provided parameters. These filters can be used with the New-XurrentShopOrderLineQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentShopOrderLineQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ShopOrderLineFilter</command:parameterValue> <dev:type> <maml:name>ShopOrderLineFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ShopOrderLineFilter</command:parameterValue> <dev:type> <maml:name>ShopOrderLineFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopOrderLineFilter</maml:name> </dev:type> <maml:description> <maml:para>a shop order line filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ShopOrderLineQuery></maml:name> </dev:type> <maml:description> <maml:para>A shop order line query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentShortUrl</command:name> <command:verb>New</command:verb> <command:noun>XurrentShortUrl</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new short uniform resource locator.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a short uniform resource locator using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentShortUrl</maml:name> <command:parameter required="false" position="0"> <maml:name>CiId</maml:name> <maml:description> <maml:para>Identifier of the CI for which a request is to be registered in Xurrent Self Service when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>DashboardId</maml:name> <maml:description> <maml:para>Identifier of the dashboard which is to be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Email</maml:name> <maml:description> <maml:para>Values for email that is to be generated when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlEmailInput</command:parameterValue> <dev:type> <maml:name>ShortUrlEmailInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Geo</maml:name> <maml:description> <maml:para>Coordinates of the location for which a map should be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlGeoInput</command:parameterValue> <dev:type> <maml:name>ShortUrlGeoInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>KnowledgeArticleId</maml:name> <maml:description> <maml:para>Identifier of the knowledge article which instructions need to be displayed when the short URL is used in Xurrent Self Service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MapAddress</maml:name> <maml:description> <maml:para>The address (or only the city or country) for which a map should be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>PlainText</maml:name> <maml:description> <maml:para>The Plain text field is used to enter the text that should be displayed when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>RequestTemplateId</maml:name> <maml:description> <maml:para>The identifier of the request template that is to be applied to each new request that is opened when in Xurrent Self Service when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SkypeName</maml:name> <maml:description> <maml:para>The Skype name that is to be called when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Sms</maml:name> <maml:description> <maml:para>Values for the SMS message that is to be generated when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlSmsInput</command:parameterValue> <dev:type> <maml:name>ShortUrlSmsInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Tel</maml:name> <maml:description> <maml:para>The telephone number that is to be called when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>The Twitter tweet that is to be generated when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>TwitterName</maml:name> <maml:description> <maml:para>The name of the Twitter user whose Twitter feed is to be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The uniform resource identifier (URI) to which the short URL is forwarded.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>WebsiteUrl</maml:name> <maml:description> <maml:para>The uniform resource locator of a website to which the short URL is to forward when it is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="16"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of short uniform resource locator properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShortUrlField[]</command:parameterValue> <dev:type> <maml:name>ShortUrlField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>CiId</maml:name> <maml:description> <maml:para>Identifier of the CI for which a request is to be registered in Xurrent Self Service when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>DashboardId</maml:name> <maml:description> <maml:para>Identifier of the dashboard which is to be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Email</maml:name> <maml:description> <maml:para>Values for email that is to be generated when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlEmailInput</command:parameterValue> <dev:type> <maml:name>ShortUrlEmailInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Geo</maml:name> <maml:description> <maml:para>Coordinates of the location for which a map should be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlGeoInput</command:parameterValue> <dev:type> <maml:name>ShortUrlGeoInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>KnowledgeArticleId</maml:name> <maml:description> <maml:para>Identifier of the knowledge article which instructions need to be displayed when the short URL is used in Xurrent Self Service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MapAddress</maml:name> <maml:description> <maml:para>The address (or only the city or country) for which a map should be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>PlainText</maml:name> <maml:description> <maml:para>The Plain text field is used to enter the text that should be displayed when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>RequestTemplateId</maml:name> <maml:description> <maml:para>The identifier of the request template that is to be applied to each new request that is opened when in Xurrent Self Service when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SkypeName</maml:name> <maml:description> <maml:para>The Skype name that is to be called when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Sms</maml:name> <maml:description> <maml:para>Values for the SMS message that is to be generated when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlSmsInput</command:parameterValue> <dev:type> <maml:name>ShortUrlSmsInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Tel</maml:name> <maml:description> <maml:para>The telephone number that is to be called when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>The Twitter tweet that is to be generated when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>TwitterName</maml:name> <maml:description> <maml:para>The name of the Twitter user whose Twitter feed is to be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The uniform resource identifier (URI) to which the short URL is forwarded.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>WebsiteUrl</maml:name> <maml:description> <maml:para>The uniform resource locator of a website to which the short URL is to forward when it is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="16"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of short uniform resource locator properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShortUrlField[]</command:parameterValue> <dev:type> <maml:name>ShortUrlField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShortUrlEmailInput</maml:name> </dev:type> <maml:description> <maml:para>A short uniform resource locator email input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShortUrlGeoInput</maml:name> </dev:type> <maml:description> <maml:para>A short uniform resource locator geo input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShortUrlSmsInput</maml:name> </dev:type> <maml:description> <maml:para>A short uniform resource locator sms input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShortUrlField[]</maml:name> </dev:type> <maml:description> <maml:para>The short uniform resource locator field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShortUrl</maml:name> </dev:type> <maml:description> <maml:para>A short uniform resource locator object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentShortUrlQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentShortUrlQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a short uniform resource locator query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentShortUrlQuery cmdlet creates and configures a short uniform resource locator query object using the provided parameters. These result can be used with the Invoke-XurrentShortUrlQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentShortUrlQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the short URL query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a short uniform resource locator properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShortUrlField[]</command:parameterValue> <dev:type> <maml:name>ShortUrlField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlView</command:parameterValue> <dev:type> <maml:name>ShortUrlView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlOrderField</command:parameterValue> <dev:type> <maml:name>ShortUrlOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ShortUrlQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ShortUrlQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ShortUrlQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the short URL query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a short uniform resource locator properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShortUrlField[]</command:parameterValue> <dev:type> <maml:name>ShortUrlField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlView</command:parameterValue> <dev:type> <maml:name>ShortUrlView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlOrderField</command:parameterValue> <dev:type> <maml:name>ShortUrlOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<ShortUrlQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<ShortUrlQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<ShortUrlQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShortUrlField[]</maml:name> </dev:type> <maml:description> <maml:para>The Short URL field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShortUrlView</maml:name> </dev:type> <maml:description> <maml:para>The short uniform resource locator view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShortUrlOrderField</maml:name> </dev:type> <maml:description> <maml:para>The short uniform resource locator order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<ShortUrlQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A short uniform resource locator query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShortUrlQuery</maml:name> </dev:type> <maml:description> <maml:para>A short uniform resource locator query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentShortUrlQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentShortUrlQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new short uniform resource locator query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentShortUrlQueryFilter cmdlet creates and configures a short uniform resource locator query filter object using the provided parameters. These filters can be used with the New-XurrentShortUrlQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentShortUrlQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ShortUrlFilter</command:parameterValue> <dev:type> <maml:name>ShortUrlFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">ShortUrlFilter</command:parameterValue> <dev:type> <maml:name>ShortUrlFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShortUrlFilter</maml:name> </dev:type> <maml:description> <maml:para>a short uniform resource locator filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<ShortUrlQuery></maml:name> </dev:type> <maml:description> <maml:para>A short uniform resource locator query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSite</command:name> <command:verb>New</command:verb> <command:noun>XurrentSite</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new site.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a site using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSite</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the site or facility.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Default: false - Whether the site may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of the site.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the site that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone in which the site is located.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of site properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteField[]</command:parameterValue> <dev:type> <maml:name>SiteField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the site or facility.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Default: false - Whether the site may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of the site.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the site that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone in which the site is located.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of site properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteField[]</command:parameterValue> <dev:type> <maml:name>SiteField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressInput[]</maml:name> </dev:type> <maml:description> <maml:para>An address input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SiteField[]</maml:name> </dev:type> <maml:description> <maml:para>The site field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Site</maml:name> </dev:type> <maml:description> <maml:para>A site object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSiteQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentSiteQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a site query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSiteQuery cmdlet creates and configures a site query object using the provided parameters. These result can be used with the Invoke-XurrentSiteQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSiteQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the site query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a site properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteField[]</command:parameterValue> <dev:type> <maml:name>SiteField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SiteView</command:parameterValue> <dev:type> <maml:name>SiteView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SiteOrderField</command:parameterValue> <dev:type> <maml:name>SiteOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Addresses</maml:name> <maml:description> <maml:para>Specify the addresses details to be returned using an address query.</maml:para> </maml:description> <command:parameterValue required="false">AddressQuery</command:parameterValue> <dev:type> <maml:name>AddressQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>People</maml:name> <maml:description> <maml:para>Specify the people details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SiteQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SiteQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SiteQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the site query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a site properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteField[]</command:parameterValue> <dev:type> <maml:name>SiteField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SiteView</command:parameterValue> <dev:type> <maml:name>SiteView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SiteOrderField</command:parameterValue> <dev:type> <maml:name>SiteOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Addresses</maml:name> <maml:description> <maml:para>Specify the addresses details to be returned using an address query.</maml:para> </maml:description> <command:parameterValue required="false">AddressQuery</command:parameterValue> <dev:type> <maml:name>AddressQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>People</maml:name> <maml:description> <maml:para>Specify the people details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SiteQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SiteQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SiteQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SiteField[]</maml:name> </dev:type> <maml:description> <maml:para>The Site field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SiteView</maml:name> </dev:type> <maml:description> <maml:para>The site view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SiteOrderField</maml:name> </dev:type> <maml:description> <maml:para>The site order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressQuery</maml:name> </dev:type> <maml:description> <maml:para>An address query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<SiteQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A site query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SiteQuery</maml:name> </dev:type> <maml:description> <maml:para>A site query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSiteQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentSiteQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new site query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSiteQueryFilter cmdlet creates and configures a site query filter object using the provided parameters. These filters can be used with the New-XurrentSiteQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSiteQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SiteFilter</command:parameterValue> <dev:type> <maml:name>SiteFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SiteFilter</command:parameterValue> <dev:type> <maml:name>SiteFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SiteFilter</maml:name> </dev:type> <maml:description> <maml:para>a site filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<SiteQuery></maml:name> </dev:type> <maml:description> <maml:para>A site query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSkillPool</command:name> <command:verb>New</command:verb> <command:noun>XurrentSkillPool</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new skill pool.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a skill pool using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSkillPool</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the skill pool.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CostPerHour</maml:name> <maml:description> <maml:para>The skill pool's estimated total cost per work hour for the service provider organization.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CostPerHourCurrency</maml:name> <maml:description> <maml:para>The currency of the cost per hour value attributed to this skill pool.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the skill pool may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EffortClassIds</maml:name> <maml:description> <maml:para>Effort classes that are linked to the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager or supervisor of the skill pool. This person is able to maintain the information about the skill pool. The manager of a skill pool does not need to be a member of the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MemberIds</maml:name> <maml:description> <maml:para>People that are linked as member to the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the skill pool that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of skill pool properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SkillPoolField[]</command:parameterValue> <dev:type> <maml:name>SkillPoolField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the skill pool.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CostPerHour</maml:name> <maml:description> <maml:para>The skill pool's estimated total cost per work hour for the service provider organization.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CostPerHourCurrency</maml:name> <maml:description> <maml:para>The currency of the cost per hour value attributed to this skill pool.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the skill pool may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EffortClassIds</maml:name> <maml:description> <maml:para>Effort classes that are linked to the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager or supervisor of the skill pool. This person is able to maintain the information about the skill pool. The manager of a skill pool does not need to be a member of the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MemberIds</maml:name> <maml:description> <maml:para>People that are linked as member to the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the skill pool that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of skill pool properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SkillPoolField[]</command:parameterValue> <dev:type> <maml:name>SkillPoolField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolField[]</maml:name> </dev:type> <maml:description> <maml:para>The skill pool field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SkillPool</maml:name> </dev:type> <maml:description> <maml:para>A skill pool object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSkillPoolQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentSkillPoolQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a skill pool query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSkillPoolQuery cmdlet creates and configures a skill pool query object using the provided parameters. These result can be used with the Invoke-XurrentSkillPoolQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSkillPoolQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the skill pool query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a skill pool properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SkillPoolField[]</command:parameterValue> <dev:type> <maml:name>SkillPoolField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolView</command:parameterValue> <dev:type> <maml:name>SkillPoolView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolOrderField</command:parameterValue> <dev:type> <maml:name>SkillPoolOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClasses</maml:name> <maml:description> <maml:para>Specify the effort classes details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Members</maml:name> <maml:description> <maml:para>Specify the members details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SkillPoolQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SkillPoolQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SkillPoolQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the skill pool query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a skill pool properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SkillPoolField[]</command:parameterValue> <dev:type> <maml:name>SkillPoolField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolView</command:parameterValue> <dev:type> <maml:name>SkillPoolView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolOrderField</command:parameterValue> <dev:type> <maml:name>SkillPoolOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClasses</maml:name> <maml:description> <maml:para>Specify the effort classes details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Members</maml:name> <maml:description> <maml:para>Specify the members details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SkillPoolQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SkillPoolQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SkillPoolQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolField[]</maml:name> </dev:type> <maml:description> <maml:para>The Skill pool field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolView</maml:name> </dev:type> <maml:description> <maml:para>The skill pool view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolOrderField</maml:name> </dev:type> <maml:description> <maml:para>The skill pool order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<SkillPoolQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A skill pool query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> <maml:description> <maml:para>A skill pool query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSkillPoolQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentSkillPoolQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new skill pool query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSkillPoolQueryFilter cmdlet creates and configures a skill pool query filter object using the provided parameters. These filters can be used with the New-XurrentSkillPoolQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSkillPoolQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SkillPoolFilter</command:parameterValue> <dev:type> <maml:name>SkillPoolFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SkillPoolFilter</command:parameterValue> <dev:type> <maml:name>SkillPoolFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolFilter</maml:name> </dev:type> <maml:description> <maml:para>a skill pool filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<SkillPoolQuery></maml:name> </dev:type> <maml:description> <maml:para>A skill pool query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSlaCoverageGroup</command:name> <command:verb>New</command:verb> <command:noun>XurrentSlaCoverageGroup</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new service level agreement coverage group.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a service level agreement coverage group using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSlaCoverageGroup</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the SLA coverage group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Any additional information about the SLA coverage group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the SLA coverage group may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SearchPhrase</maml:name> <maml:description> <maml:para>The phrase used to filter the people.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="8"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service level agreement coverage group properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaCoverageGroupField[]</command:parameterValue> <dev:type> <maml:name>SlaCoverageGroupField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the SLA coverage group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Any additional information about the SLA coverage group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the SLA coverage group may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SearchPhrase</maml:name> <maml:description> <maml:para>The phrase used to filter the people.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="8"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service level agreement coverage group properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaCoverageGroupField[]</command:parameterValue> <dev:type> <maml:name>SlaCoverageGroupField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaCoverageGroupField[]</maml:name> </dev:type> <maml:description> <maml:para>The service level agreement coverage group field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SlaCoverageGroup</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement coverage group object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSlaCoverageGroupQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentSlaCoverageGroupQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a service level agreement coverage group query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSlaCoverageGroupQuery cmdlet creates and configures a service level agreement coverage group query object using the provided parameters. These result can be used with the Invoke-XurrentSlaCoverageGroupQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSlaCoverageGroupQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service level agreement coverage group properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaCoverageGroupField[]</command:parameterValue> <dev:type> <maml:name>SlaCoverageGroupField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>People</maml:name> <maml:description> <maml:para>Specify the people details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Slas</maml:name> <maml:description> <maml:para>Specify the SLAs details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service level agreement coverage group properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaCoverageGroupField[]</command:parameterValue> <dev:type> <maml:name>SlaCoverageGroupField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>People</maml:name> <maml:description> <maml:para>Specify the people details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Slas</maml:name> <maml:description> <maml:para>Specify the SLAs details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaCoverageGroupField[]</maml:name> </dev:type> <maml:description> <maml:para>The SLA coverage group field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SlaCoverageGroupQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement coverage group query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSlaNotificationRuleQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentSlaNotificationRuleQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a service level agreement notification rule query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSlaNotificationRuleQuery cmdlet creates and configures a service level agreement notification rule query object using the provided parameters. These result can be used with the Invoke-XurrentSlaNotificationRuleQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSlaNotificationRuleQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service level agreement notification rule properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaNotificationRuleField[]</command:parameterValue> <dev:type> <maml:name>SlaNotificationRuleField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service level agreement notification rule properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaNotificationRuleField[]</command:parameterValue> <dev:type> <maml:name>SlaNotificationRuleField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaNotificationRuleField[]</maml:name> </dev:type> <maml:description> <maml:para>The SLA notification rule field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SlaNotificationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement notification rule query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSlaNotificationScheme</command:name> <command:verb>New</command:verb> <command:noun>XurrentSlaNotificationScheme</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new service level agreement notification scheme.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a service level agreement notification scheme using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSlaNotificationScheme</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the SLA notification scheme.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the SLA notification scheme may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>NewSlaNotificationRules</maml:name> <maml:description> <maml:para>Rules of this SLA notification scheme.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationRuleInput[]</command:parameterValue> <dev:type> <maml:name>SlaNotificationRuleInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="6"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service level agreement notification scheme properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaNotificationSchemeField[]</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the SLA notification scheme.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the SLA notification scheme may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>NewSlaNotificationRules</maml:name> <maml:description> <maml:para>Rules of this SLA notification scheme.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationRuleInput[]</command:parameterValue> <dev:type> <maml:name>SlaNotificationRuleInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="6"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service level agreement notification scheme properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaNotificationSchemeField[]</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaNotificationRuleInput[]</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement notification rule input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaNotificationSchemeField[]</maml:name> </dev:type> <maml:description> <maml:para>The service level agreement notification scheme field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SlaNotificationScheme</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement notification scheme object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSlaNotificationSchemeQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentSlaNotificationSchemeQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a service level agreement notification scheme query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSlaNotificationSchemeQuery cmdlet creates and configures a service level agreement notification scheme query object using the provided parameters. These result can be used with the Invoke-XurrentSlaNotificationSchemeQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSlaNotificationSchemeQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the SLA notification scheme query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service level agreement notification scheme properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaNotificationSchemeField[]</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SlaNotificationRules</maml:name> <maml:description> <maml:para>Specify the SLA notification rules details to be returned using a service level agreement notification rule query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationRuleQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SlaNotificationSchemeQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SlaNotificationSchemeQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SlaNotificationSchemeQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the SLA notification scheme query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a service level agreement notification scheme properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaNotificationSchemeField[]</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SlaNotificationRules</maml:name> <maml:description> <maml:para>Specify the SLA notification rules details to be returned using a service level agreement notification rule query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationRuleQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SlaNotificationSchemeQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SlaNotificationSchemeQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SlaNotificationSchemeQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaNotificationSchemeField[]</maml:name> </dev:type> <maml:description> <maml:para>The SLA notification scheme field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaNotificationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement notification rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<SlaNotificationSchemeQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement notification scheme query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement notification scheme query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSlaNotificationSchemeQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentSlaNotificationSchemeQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new service level agreement notification scheme query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSlaNotificationSchemeQueryFilter cmdlet creates and configures a service level agreement notification scheme query filter object using the provided parameters. These filters can be used with the New-XurrentSlaNotificationSchemeQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSlaNotificationSchemeQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SlaNotificationSchemeFilter</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SlaNotificationSchemeFilter</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaNotificationSchemeFilter</maml:name> </dev:type> <maml:description> <maml:para>a service level agreement notification scheme filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<SlaNotificationSchemeQuery></maml:name> </dev:type> <maml:description> <maml:para>A service level agreement notification scheme query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSnapshotQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentSnapshotQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a snapshot query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSnapshotQuery cmdlet creates and configures a snapshot query object using the provided parameters. These result can be used with the Invoke-XurrentSnapshotQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSnapshotQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a snapshot properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SnapshotField[]</command:parameterValue> <dev:type> <maml:name>SnapshotField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a snapshot properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SnapshotField[]</command:parameterValue> <dev:type> <maml:name>SnapshotField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SnapshotField[]</maml:name> </dev:type> <maml:description> <maml:para>The Snapshot field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SnapshotQuery</maml:name> </dev:type> <maml:description> <maml:para>A snapshot query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSprint</command:name> <command:verb>New</command:verb> <command:noun>XurrentSprint</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new sprint.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a sprint using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSprint</maml:name> <command:parameter required="true" position="0"> <maml:name>ScrumWorkspaceId</maml:name> <maml:description> <maml:para>Identifier of scrum workspace this sprint belongs to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of this sprint (e.g. goal of the sprint).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>The date and time the sprint ended, or will end.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>NewSprintBacklogItems</maml:name> <maml:description> <maml:para>Sprint backlog items of this sprint.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemInput[]</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Number</maml:name> <maml:description> <maml:para>Sequence number of this sprint.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The date and time the sprint started, or will start.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the sprint.</maml:para> </maml:description> <command:parameterValue required="false">SprintStatus</command:parameterValue> <dev:type> <maml:name>SprintStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of sprint properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SprintField[]</command:parameterValue> <dev:type> <maml:name>SprintField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ScrumWorkspaceId</maml:name> <maml:description> <maml:para>Identifier of scrum workspace this sprint belongs to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of this sprint (e.g. goal of the sprint).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>The date and time the sprint ended, or will end.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>NewSprintBacklogItems</maml:name> <maml:description> <maml:para>Sprint backlog items of this sprint.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemInput[]</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Number</maml:name> <maml:description> <maml:para>Sequence number of this sprint.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The date and time the sprint started, or will start.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the sprint.</maml:para> </maml:description> <command:parameterValue required="false">SprintStatus</command:parameterValue> <dev:type> <maml:name>SprintStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of sprint properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SprintField[]</command:parameterValue> <dev:type> <maml:name>SprintField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintBacklogItemInput[]</maml:name> </dev:type> <maml:description> <maml:para>A sprint backlog item input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintStatus</maml:name> </dev:type> <maml:description> <maml:para>A sprint status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintField[]</maml:name> </dev:type> <maml:description> <maml:para>The sprint field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Sprint</maml:name> </dev:type> <maml:description> <maml:para>A sprint object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSprintBacklogItemQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentSprintBacklogItemQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a sprint backlog item query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSprintBacklogItemQuery cmdlet creates and configures a sprint backlog item query object using the provided parameters. These result can be used with the Invoke-XurrentSprintBacklogItemQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSprintBacklogItemQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a sprint backlog item properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SprintBacklogItemField[]</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>RecordProblem</maml:name> <maml:description> <maml:para>Specify the record Problem to be returned using a problem query. This only applies if the item is a problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>RecordProjectTask</maml:name> <maml:description> <maml:para>Specify the record Project task to be returned using a project task query. This only applies if the item is a project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>RecordRequest</maml:name> <maml:description> <maml:para>Specify the record Request to be returned using a request query. This only applies if the item is a request.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>RecordTask</maml:name> <maml:description> <maml:para>Specify the record Task to be returned using a task query. This only applies if the item is a task.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Sprint</maml:name> <maml:description> <maml:para>Specify the sprint details to be returned using a sprint query.</maml:para> </maml:description> <command:parameterValue required="false">SprintQuery</command:parameterValue> <dev:type> <maml:name>SprintQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a sprint backlog item properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SprintBacklogItemField[]</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>RecordProblem</maml:name> <maml:description> <maml:para>Specify the record Problem to be returned using a problem query. This only applies if the item is a problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>RecordProjectTask</maml:name> <maml:description> <maml:para>Specify the record Project task to be returned using a project task query. This only applies if the item is a project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>RecordRequest</maml:name> <maml:description> <maml:para>Specify the record Request to be returned using a request query. This only applies if the item is a request.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>RecordTask</maml:name> <maml:description> <maml:para>Specify the record Task to be returned using a task query. This only applies if the item is a task.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Sprint</maml:name> <maml:description> <maml:para>Specify the sprint details to be returned using a sprint query.</maml:para> </maml:description> <command:parameterValue required="false">SprintQuery</command:parameterValue> <dev:type> <maml:name>SprintQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintBacklogItemField[]</maml:name> </dev:type> <maml:description> <maml:para>The Sprint backlog item field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemQuery</maml:name> </dev:type> <maml:description> <maml:para>A problem query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintQuery</maml:name> </dev:type> <maml:description> <maml:para>A sprint query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SprintBacklogItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A sprint backlog item query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSprintQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentSprintQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a sprint query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSprintQuery cmdlet creates and configures a sprint query object using the provided parameters. These result can be used with the Invoke-XurrentSprintQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSprintQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the sprint query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a sprint properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SprintField[]</command:parameterValue> <dev:type> <maml:name>SprintField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SprintView</command:parameterValue> <dev:type> <maml:name>SprintView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SprintOrderField</command:parameterValue> <dev:type> <maml:name>SprintOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ScrumWorkspace</maml:name> <maml:description> <maml:para>Specify the scrum workspace details to be returned using a scrum workspace query.</maml:para> </maml:description> <command:parameterValue required="false">ScrumWorkspaceQuery</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SprintBacklogItems</maml:name> <maml:description> <maml:para>Specify the sprint backlog items details to be returned using a sprint backlog item query.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemQuery</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SprintQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SprintQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SprintQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the sprint query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a sprint properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SprintField[]</command:parameterValue> <dev:type> <maml:name>SprintField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SprintView</command:parameterValue> <dev:type> <maml:name>SprintView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SprintOrderField</command:parameterValue> <dev:type> <maml:name>SprintOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ScrumWorkspace</maml:name> <maml:description> <maml:para>Specify the scrum workspace details to be returned using a scrum workspace query.</maml:para> </maml:description> <command:parameterValue required="false">ScrumWorkspaceQuery</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SprintBacklogItems</maml:name> <maml:description> <maml:para>Specify the sprint backlog items details to be returned using a sprint backlog item query.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemQuery</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SprintQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SprintQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SprintQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintField[]</maml:name> </dev:type> <maml:description> <maml:para>The Sprint field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintView</maml:name> </dev:type> <maml:description> <maml:para>The sprint view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintOrderField</maml:name> </dev:type> <maml:description> <maml:para>The sprint order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ScrumWorkspaceQuery</maml:name> </dev:type> <maml:description> <maml:para>A scrum workspace query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintBacklogItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A sprint backlog item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<SprintQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A sprint query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SprintQuery</maml:name> </dev:type> <maml:description> <maml:para>A sprint query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSprintQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentSprintQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new sprint query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSprintQueryFilter cmdlet creates and configures a sprint query filter object using the provided parameters. These filters can be used with the New-XurrentSprintQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSprintQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SprintFilter</command:parameterValue> <dev:type> <maml:name>SprintFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SprintFilter</command:parameterValue> <dev:type> <maml:name>SprintFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintFilter</maml:name> </dev:type> <maml:description> <maml:para>a sprint filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<SprintQuery></maml:name> </dev:type> <maml:description> <maml:para>A sprint query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentStandardServiceRequestActivityIDQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentStandardServiceRequestActivityIDQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a standard service request activity identifier query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentStandardServiceRequestActivityIDQuery cmdlet creates and configures a standard service request activity identifier query object using the provided parameters. These result can be used with the Invoke-XurrentStandardServiceRequestActivityIDQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentStandardServiceRequestActivityIDQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a standard service request activity identifier properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">StandardServiceRequestActivityIDField[]</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestActivityIDField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>StandardServiceRequest</maml:name> <maml:description> <maml:para>Specify the standard service request details to be returned using a standard service request query.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestQuery</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a standard service request activity identifier properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">StandardServiceRequestActivityIDField[]</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestActivityIDField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>StandardServiceRequest</maml:name> <maml:description> <maml:para>Specify the standard service request details to be returned using a standard service request query.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestQuery</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.StandardServiceRequestActivityIDField[]</maml:name> </dev:type> <maml:description> <maml:para>The Standard service request activity ID field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.StandardServiceRequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A standard service request query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>StandardServiceRequestActivityIDQuery</maml:name> </dev:type> <maml:description> <maml:para>A standard service request activity identifier query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentStandardServiceRequestQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentStandardServiceRequestQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a standard service request query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentStandardServiceRequestQuery cmdlet creates and configures a standard service request query object using the provided parameters. These result can be used with the Invoke-XurrentStandardServiceRequestQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentStandardServiceRequestQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a standard service request properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">StandardServiceRequestField[]</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>RequestTemplate</maml:name> <maml:description> <maml:para>Specify the request template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ResolutionTargetNotificationScheme</maml:name> <maml:description> <maml:para>Specify the resolution target notification scheme details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ResponseTargetNotificationScheme</maml:name> <maml:description> <maml:para>Specify the response target notification scheme details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServiceOffering</maml:name> <maml:description> <maml:para>Specify the service offering details to be returned using a service offering query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingQuery</command:parameterValue> <dev:type> <maml:name>ServiceOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SupportHours</maml:name> <maml:description> <maml:para>Specify the support hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a standard service request properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">StandardServiceRequestField[]</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>RequestTemplate</maml:name> <maml:description> <maml:para>Specify the request template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ResolutionTargetNotificationScheme</maml:name> <maml:description> <maml:para>Specify the resolution target notification scheme details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ResponseTargetNotificationScheme</maml:name> <maml:description> <maml:para>Specify the response target notification scheme details to be returned using a service level agreement notification scheme query.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationSchemeQuery</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServiceOffering</maml:name> <maml:description> <maml:para>Specify the service offering details to be returned using a service offering query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingQuery</command:parameterValue> <dev:type> <maml:name>ServiceOfferingQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SupportHours</maml:name> <maml:description> <maml:para>Specify the support hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.StandardServiceRequestField[]</maml:name> </dev:type> <maml:description> <maml:para>The Standard service request field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A request template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaNotificationSchemeQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement notification scheme query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingQuery</maml:name> </dev:type> <maml:description> <maml:para>A service offering query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>StandardServiceRequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A standard service request query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSurvey</command:name> <command:verb>New</command:verb> <command:noun>XurrentSurvey</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new survey.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a survey using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSurvey</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the survey.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the survey may not be used.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>NewQuestions</maml:name> <maml:description> <maml:para>Questions of this survey.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuestionInput[]</command:parameterValue> <dev:type> <maml:name>SurveyQuestionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="7"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of survey properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyField[]</command:parameterValue> <dev:type> <maml:name>SurveyField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the survey.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the survey may not be used.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>NewQuestions</maml:name> <maml:description> <maml:para>Questions of this survey.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuestionInput[]</command:parameterValue> <dev:type> <maml:name>SurveyQuestionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="7"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of survey properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyField[]</command:parameterValue> <dev:type> <maml:name>SurveyField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyQuestionInput[]</maml:name> </dev:type> <maml:description> <maml:para>A survey question input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyField[]</maml:name> </dev:type> <maml:description> <maml:para>The survey field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Survey</maml:name> </dev:type> <maml:description> <maml:para>A survey object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSurveyAnswerQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentSurveyAnswerQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a survey answer query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSurveyAnswerQuery cmdlet creates and configures a survey answer query object using the provided parameters. These result can be used with the Invoke-XurrentSurveyAnswerQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSurveyAnswerQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a survey answer properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyAnswerField[]</command:parameterValue> <dev:type> <maml:name>SurveyAnswerField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Question</maml:name> <maml:description> <maml:para>Specify the question details to be returned using a survey question query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuestionQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuestionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>SurveyResponse</maml:name> <maml:description> <maml:para>Specify the survey response details to be returned using a survey response query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyResponseQuery</command:parameterValue> <dev:type> <maml:name>SurveyResponseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>TextAttachments</maml:name> <maml:description> <maml:para>Specify the text attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a survey answer properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyAnswerField[]</command:parameterValue> <dev:type> <maml:name>SurveyAnswerField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Question</maml:name> <maml:description> <maml:para>Specify the question details to be returned using a survey question query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuestionQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuestionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>SurveyResponse</maml:name> <maml:description> <maml:para>Specify the survey response details to be returned using a survey response query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyResponseQuery</command:parameterValue> <dev:type> <maml:name>SurveyResponseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>TextAttachments</maml:name> <maml:description> <maml:para>Specify the text attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyAnswerField[]</maml:name> </dev:type> <maml:description> <maml:para>The Survey answer field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyQuestionQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey question query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyResponseQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey response query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SurveyAnswerQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey answer query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSurveyQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentSurveyQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a survey query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSurveyQuery cmdlet creates and configures a survey query object using the provided parameters. These result can be used with the Invoke-XurrentSurveyQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSurveyQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the survey query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a survey properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyField[]</command:parameterValue> <dev:type> <maml:name>SurveyField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SurveyView</command:parameterValue> <dev:type> <maml:name>SurveyView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SurveyOrderField</command:parameterValue> <dev:type> <maml:name>SurveyOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CompletionAttachments</maml:name> <maml:description> <maml:para>Specify the completion attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>IntroductionAttachments</maml:name> <maml:description> <maml:para>Specify the introduction attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Questions</maml:name> <maml:description> <maml:para>Specify the questions details to be returned using a survey question query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuestionQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuestionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SurveyQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SurveyQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SurveyQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the survey query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a survey properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyField[]</command:parameterValue> <dev:type> <maml:name>SurveyField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SurveyView</command:parameterValue> <dev:type> <maml:name>SurveyView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SurveyOrderField</command:parameterValue> <dev:type> <maml:name>SurveyOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CompletionAttachments</maml:name> <maml:description> <maml:para>Specify the completion attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>IntroductionAttachments</maml:name> <maml:description> <maml:para>Specify the introduction attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Questions</maml:name> <maml:description> <maml:para>Specify the questions details to be returned using a survey question query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuestionQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuestionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SurveyQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SurveyQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SurveyQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyField[]</maml:name> </dev:type> <maml:description> <maml:para>The Survey field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyView</maml:name> </dev:type> <maml:description> <maml:para>The survey view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyOrderField</maml:name> </dev:type> <maml:description> <maml:para>The survey order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyQuestionQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey question query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<SurveyQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A survey query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SurveyQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSurveyQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentSurveyQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new survey query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSurveyQueryFilter cmdlet creates and configures a survey query filter object using the provided parameters. These filters can be used with the New-XurrentSurveyQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSurveyQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SurveyFilter</command:parameterValue> <dev:type> <maml:name>SurveyFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SurveyFilter</command:parameterValue> <dev:type> <maml:name>SurveyFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyFilter</maml:name> </dev:type> <maml:description> <maml:para>a survey filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<SurveyQuery></maml:name> </dev:type> <maml:description> <maml:para>A survey query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSurveyQuestionQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentSurveyQuestionQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a survey question query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSurveyQuestionQuery cmdlet creates and configures a survey question query object using the provided parameters. These result can be used with the Invoke-XurrentSurveyQuestionQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSurveyQuestionQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a survey question properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyQuestionField[]</command:parameterValue> <dev:type> <maml:name>SurveyQuestionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>GuidanceAttachments</maml:name> <maml:description> <maml:para>Specify the guidance attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Survey</maml:name> <maml:description> <maml:para>Specify the survey details to be returned using a survey query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a survey question properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyQuestionField[]</command:parameterValue> <dev:type> <maml:name>SurveyQuestionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>GuidanceAttachments</maml:name> <maml:description> <maml:para>Specify the guidance attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Survey</maml:name> <maml:description> <maml:para>Specify the survey details to be returned using a survey query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyQuestionField[]</maml:name> </dev:type> <maml:description> <maml:para>The Survey question field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SurveyQuestionQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey question query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSurveyResponse</command:name> <command:verb>New</command:verb> <command:noun>XurrentSurveyResponse</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new survey response.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a survey response using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSurveyResponse</maml:name> <command:parameter required="true" position="0"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service this response is about.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SurveyId</maml:name> <maml:description> <maml:para>Identifier of the survey this response is for.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Completed</maml:name> <maml:description> <maml:para>Whether the respondent completed the survey.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewAnswers</maml:name> <maml:description> <maml:para>Answers of this survey response.</maml:para> </maml:description> <command:parameterValue required="false">SurveyAnswerInput[]</command:parameterValue> <dev:type> <maml:name>SurveyAnswerInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person who provided this response (i.e. the respondent).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Rating</maml:name> <maml:description> <maml:para>Rating calculated based on the answers.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>RatingCalculation</maml:name> <maml:description> <maml:para>How the individual answers were combined to calculate the rating.</maml:para> </maml:description> <command:parameterValue required="false">JToken</command:parameterValue> <dev:type> <maml:name>JToken</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>RespondedAt</maml:name> <maml:description> <maml:para>Time this response was submitted.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SlaIds</maml:name> <maml:description> <maml:para>Identifiers of the SLAs this response is for. (Ignored when supplying a personId.)</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="12"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of survey response properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyResponseField[]</command:parameterValue> <dev:type> <maml:name>SurveyResponseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service this response is about.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SurveyId</maml:name> <maml:description> <maml:para>Identifier of the survey this response is for.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Completed</maml:name> <maml:description> <maml:para>Whether the respondent completed the survey.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewAnswers</maml:name> <maml:description> <maml:para>Answers of this survey response.</maml:para> </maml:description> <command:parameterValue required="false">SurveyAnswerInput[]</command:parameterValue> <dev:type> <maml:name>SurveyAnswerInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person who provided this response (i.e. the respondent).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Rating</maml:name> <maml:description> <maml:para>Rating calculated based on the answers.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>RatingCalculation</maml:name> <maml:description> <maml:para>How the individual answers were combined to calculate the rating.</maml:para> </maml:description> <command:parameterValue required="false">JToken</command:parameterValue> <dev:type> <maml:name>JToken</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>RespondedAt</maml:name> <maml:description> <maml:para>Time this response was submitted.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SlaIds</maml:name> <maml:description> <maml:para>Identifiers of the SLAs this response is for. (Ignored when supplying a personId.)</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="12"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of survey response properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyResponseField[]</command:parameterValue> <dev:type> <maml:name>SurveyResponseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyAnswerInput[]</maml:name> </dev:type> <maml:description> <maml:para>A survey answer input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Newtonsoft.Json.Linq.JToken</maml:name> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyResponseField[]</maml:name> </dev:type> <maml:description> <maml:para>The survey response field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SurveyResponse</maml:name> </dev:type> <maml:description> <maml:para>A survey response object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSurveyResponseQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentSurveyResponseQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a survey response query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSurveyResponseQuery cmdlet creates and configures a survey response query object using the provided parameters. These result can be used with the Invoke-XurrentSurveyResponseQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSurveyResponseQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the survey response query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a survey response properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyResponseField[]</command:parameterValue> <dev:type> <maml:name>SurveyResponseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SurveyResponseView</command:parameterValue> <dev:type> <maml:name>SurveyResponseView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SurveyResponseOrderField</command:parameterValue> <dev:type> <maml:name>SurveyResponseOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Answers</maml:name> <maml:description> <maml:para>Specify the answers details to be returned using a survey answer query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyAnswerQuery</command:parameterValue> <dev:type> <maml:name>SurveyAnswerQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Slas</maml:name> <maml:description> <maml:para>Specify the SLAs details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Survey</maml:name> <maml:description> <maml:para>Specify the survey details to be returned using a survey query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SurveyResponseQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SurveyResponseQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SurveyResponseQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the survey response query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a survey response properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyResponseField[]</command:parameterValue> <dev:type> <maml:name>SurveyResponseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SurveyResponseView</command:parameterValue> <dev:type> <maml:name>SurveyResponseView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">SurveyResponseOrderField</command:parameterValue> <dev:type> <maml:name>SurveyResponseOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Answers</maml:name> <maml:description> <maml:para>Specify the answers details to be returned using a survey answer query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyAnswerQuery</command:parameterValue> <dev:type> <maml:name>SurveyAnswerQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Slas</maml:name> <maml:description> <maml:para>Specify the SLAs details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Survey</maml:name> <maml:description> <maml:para>Specify the survey details to be returned using a survey query.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SurveyResponseQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SurveyResponseQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SurveyResponseQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyResponseField[]</maml:name> </dev:type> <maml:description> <maml:para>The Survey response field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyResponseView</maml:name> </dev:type> <maml:description> <maml:para>The survey response view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyResponseOrderField</maml:name> </dev:type> <maml:description> <maml:para>The survey response order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyAnswerQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey answer query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<SurveyResponseQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A survey response query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SurveyResponseQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey response query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSurveyResponseQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentSurveyResponseQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new survey response query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSurveyResponseQueryFilter cmdlet creates and configures a survey response query filter object using the provided parameters. These filters can be used with the New-XurrentSurveyResponseQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSurveyResponseQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SurveyResponseFilter</command:parameterValue> <dev:type> <maml:name>SurveyResponseFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SurveyResponseFilter</command:parameterValue> <dev:type> <maml:name>SurveyResponseFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyResponseFilter</maml:name> </dev:type> <maml:description> <maml:para>a survey response filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<SurveyResponseQuery></maml:name> </dev:type> <maml:description> <maml:para>A survey response query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSyncSetQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentSyncSetQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a sync set query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSyncSetQuery cmdlet creates and configures a sync set query object using the provided parameters. These result can be used with the Invoke-XurrentSyncSetQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSyncSetQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the sync set query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a sync set properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SyncSetField[]</command:parameterValue> <dev:type> <maml:name>SyncSetField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>LastSnapshot</maml:name> <maml:description> <maml:para>Specify the last snapshot details to be returned using a snapshot query.</maml:para> </maml:description> <command:parameterValue required="false">SnapshotQuery</command:parameterValue> <dev:type> <maml:name>SnapshotQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SelectedRecords</maml:name> <maml:description> <maml:para>Specify the selected records details to be returned using a record query.</maml:para> </maml:description> <command:parameterValue required="false">RecordQuery</command:parameterValue> <dev:type> <maml:name>RecordQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SyncSetQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SyncSetQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SyncSetQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the sync set query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a sync set properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SyncSetField[]</command:parameterValue> <dev:type> <maml:name>SyncSetField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>LastSnapshot</maml:name> <maml:description> <maml:para>Specify the last snapshot details to be returned using a snapshot query.</maml:para> </maml:description> <command:parameterValue required="false">SnapshotQuery</command:parameterValue> <dev:type> <maml:name>SnapshotQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SelectedRecords</maml:name> <maml:description> <maml:para>Specify the selected records details to be returned using a record query.</maml:para> </maml:description> <command:parameterValue required="false">RecordQuery</command:parameterValue> <dev:type> <maml:name>RecordQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<SyncSetQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<SyncSetQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<SyncSetQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SyncSetField[]</maml:name> </dev:type> <maml:description> <maml:para>The Sync set field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SnapshotQuery</maml:name> </dev:type> <maml:description> <maml:para>A snapshot query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecordQuery</maml:name> </dev:type> <maml:description> <maml:para>A record query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<SyncSetQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A sync set query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SyncSetQuery</maml:name> </dev:type> <maml:description> <maml:para>A sync set query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentSyncSetQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentSyncSetQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new sync set query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentSyncSetQueryFilter cmdlet creates and configures a sync set query filter object using the provided parameters. These filters can be used with the New-XurrentSyncSetQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentSyncSetQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SyncSetFilter</command:parameterValue> <dev:type> <maml:name>SyncSetFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">SyncSetFilter</command:parameterValue> <dev:type> <maml:name>SyncSetFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SyncSetFilter</maml:name> </dev:type> <maml:description> <maml:para>a sync set filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<SyncSetQuery></maml:name> </dev:type> <maml:description> <maml:para>A sync set query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTagQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentTagQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a tag query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTagQuery cmdlet creates and configures a tag query object using the provided parameters. These result can be used with the Invoke-XurrentTagQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTagQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a tag properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TagField[]</command:parameterValue> <dev:type> <maml:name>TagField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a tag properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TagField[]</command:parameterValue> <dev:type> <maml:name>TagField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TagField[]</maml:name> </dev:type> <maml:description> <maml:para>The Tag field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TagQuery</maml:name> </dev:type> <maml:description> <maml:para>A tag query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTask</command:name> <command:verb>New</command:verb> <command:noun>XurrentTask</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new task.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a task using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTask</maml:name> <command:parameter required="true" position="0"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>Identifier of the workflow to which the task belongs.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AssignedAt</maml:name> <maml:description> <maml:para>Automatically set to the current date and time when the task is assigned.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the task. Risk & impact tasks are used to help plan workflows. Approval tasks are used to collect approvals for workflows. These can be used at various stages in the life of the workflow. Implementation tasks are added to workflows for development, installation, configuration, test, transfer and administrative work that needs to be completed for the implementation of the workflow.</maml:para> </maml:description> <command:parameterValue required="false">TaskCategory</command:parameterValue> <dev:type> <maml:name>TaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>FinishedAt</maml:name> <maml:description> <maml:para>Automatically set to the date and time at which the task is saved with the status "Failed", "Rejected", "Completed", "Approved" or "Canceled".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Impact</maml:name> <maml:description> <maml:para>The extent to which the service instances related to the task will be impacted by the completion of the task.</maml:para> </maml:description> <command:parameterValue required="false">TaskImpact</command:parameterValue> <dev:type> <maml:name>TaskImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Used to provide instructions for the person to whom the task will be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the instructions field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person to whom the task is to be assigned. This field's value is null in case of an approval task with multiple approvers.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>NewApprovals</maml:name> <maml:description> <maml:para>Approvals of the task.</maml:para> </maml:description> <command:parameterValue required="false">TaskApprovalInput[]</command:parameterValue> <dev:type> <maml:name>TaskApprovalInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Note</maml:name> <maml:description> <maml:para>Used to provide information for the person to whom the task is assigned. It is also used to provide a summary of the actions that have been taken to date and the results of these actions.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>The attachments used in the note field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design associated with the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PhaseId</maml:name> <maml:description> <maml:para>Identifier of the phase of the workflow to which the task belongs.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>The number of minutes it is expected to take for the task to be completed following its assignment, or following its fixed start date and time if the Start no earlier than field is filled out.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>The number of minutes the member is expected to spend working on the task.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>PredecessorIds</maml:name> <maml:description> <maml:para>Identifiers of predecessors of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>RequestServiceInstanceId</maml:name> <maml:description> <maml:para>The identifier of the service instance that should be used to create the request for this task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>RequestTemplateId</maml:name> <maml:description> <maml:para>The identifier of the request template that should be used to create the request for this task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number of approvers who need to have provided their approval before the status of the task gets updated to "Approved".</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of service instances of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Only used when work on the task may not start before a specific date and time.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>Status</maml:name> <maml:description> <maml:para>The Status field is used to select the current status of the task.</maml:para> </maml:description> <command:parameterValue required="false">TaskStatus</command:parameterValue> <dev:type> <maml:name>TaskStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SuccessorIds</maml:name> <maml:description> <maml:para>Identifiers of successors of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that has been asked to assist with the completion of the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request to help with the execution of the task has been registered at the supplier organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team to which the task is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>Identifier of the task template that was used to register the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether the task has been marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the task is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>When set to true, the completion target of the task is calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="42"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of task properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskField[]</command:parameterValue> <dev:type> <maml:name>TaskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>Identifier of the workflow to which the task belongs.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AssignedAt</maml:name> <maml:description> <maml:para>Automatically set to the current date and time when the task is assigned.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the task. Risk & impact tasks are used to help plan workflows. Approval tasks are used to collect approvals for workflows. These can be used at various stages in the life of the workflow. Implementation tasks are added to workflows for development, installation, configuration, test, transfer and administrative work that needs to be completed for the implementation of the workflow.</maml:para> </maml:description> <command:parameterValue required="false">TaskCategory</command:parameterValue> <dev:type> <maml:name>TaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>FinishedAt</maml:name> <maml:description> <maml:para>Automatically set to the date and time at which the task is saved with the status "Failed", "Rejected", "Completed", "Approved" or "Canceled".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Impact</maml:name> <maml:description> <maml:para>The extent to which the service instances related to the task will be impacted by the completion of the task.</maml:para> </maml:description> <command:parameterValue required="false">TaskImpact</command:parameterValue> <dev:type> <maml:name>TaskImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Used to provide instructions for the person to whom the task will be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the instructions field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person to whom the task is to be assigned. This field's value is null in case of an approval task with multiple approvers.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>NewApprovals</maml:name> <maml:description> <maml:para>Approvals of the task.</maml:para> </maml:description> <command:parameterValue required="false">TaskApprovalInput[]</command:parameterValue> <dev:type> <maml:name>TaskApprovalInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Note</maml:name> <maml:description> <maml:para>Used to provide information for the person to whom the task is assigned. It is also used to provide a summary of the actions that have been taken to date and the results of these actions.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>The attachments used in the note field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design associated with the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PhaseId</maml:name> <maml:description> <maml:para>Identifier of the phase of the workflow to which the task belongs.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>The number of minutes it is expected to take for the task to be completed following its assignment, or following its fixed start date and time if the Start no earlier than field is filled out.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>The number of minutes the member is expected to spend working on the task.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>PredecessorIds</maml:name> <maml:description> <maml:para>Identifiers of predecessors of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>RequestServiceInstanceId</maml:name> <maml:description> <maml:para>The identifier of the service instance that should be used to create the request for this task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>RequestTemplateId</maml:name> <maml:description> <maml:para>The identifier of the request template that should be used to create the request for this task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number of approvers who need to have provided their approval before the status of the task gets updated to "Approved".</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of service instances of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Only used when work on the task may not start before a specific date and time.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>Status</maml:name> <maml:description> <maml:para>The Status field is used to select the current status of the task.</maml:para> </maml:description> <command:parameterValue required="false">TaskStatus</command:parameterValue> <dev:type> <maml:name>TaskStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SuccessorIds</maml:name> <maml:description> <maml:para>Identifiers of successors of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that has been asked to assist with the completion of the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request to help with the execution of the task has been registered at the supplier organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team to which the task is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>Identifier of the task template that was used to register the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether the task has been marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the task is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>When set to true, the completion target of the task is calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="42"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of task properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskField[]</command:parameterValue> <dev:type> <maml:name>TaskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskCategory</maml:name> </dev:type> <maml:description> <maml:para>A task category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskImpact</maml:name> </dev:type> <maml:description> <maml:para>A task impact object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskApprovalInput[]</maml:name> </dev:type> <maml:description> <maml:para>A task approval input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskStatus</maml:name> </dev:type> <maml:description> <maml:para>A task status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskField[]</maml:name> </dev:type> <maml:description> <maml:para>The task field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para>A task object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTaskApprovalQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentTaskApprovalQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a task approval query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTaskApprovalQuery cmdlet creates and configures a task approval query object using the provided parameters. These result can be used with the Invoke-XurrentTaskApprovalQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTaskApprovalQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a task approval properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskApprovalField[]</command:parameterValue> <dev:type> <maml:name>TaskApprovalField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Approver</maml:name> <maml:description> <maml:para>Specify the approver details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Attachment</maml:name> <maml:description> <maml:para>Specify the attachment details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a task approval properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskApprovalField[]</command:parameterValue> <dev:type> <maml:name>TaskApprovalField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Approver</maml:name> <maml:description> <maml:para>Specify the approver details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Attachment</maml:name> <maml:description> <maml:para>Specify the attachment details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskApprovalField[]</maml:name> </dev:type> <maml:description> <maml:para>The Task approval field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TaskApprovalQuery</maml:name> </dev:type> <maml:description> <maml:para>A task approval query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTaskQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentTaskQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a task query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTaskQuery cmdlet creates and configures a task query object using the provided parameters. These result can be used with the Invoke-XurrentTaskQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTaskQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the task query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a task properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskField[]</command:parameterValue> <dev:type> <maml:name>TaskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TaskView</command:parameterValue> <dev:type> <maml:name>TaskView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TaskOrderField</command:parameterValue> <dev:type> <maml:name>TaskOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AgileBoardColumn</maml:name> <maml:description> <maml:para>Specify the agile board column details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Approvals</maml:name> <maml:description> <maml:para>Specify the approvals details to be returned using a task approval query.</maml:para> </maml:description> <command:parameterValue required="false">TaskApprovalQuery</command:parameterValue> <dev:type> <maml:name>TaskApprovalQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>FailureTask</maml:name> <maml:description> <maml:para>Specify the failure task details to be returned using a task query.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specify the member details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>OrderLine</maml:name> <maml:description> <maml:para>Specify the order line details to be returned using a shop order line query.</maml:para> </maml:description> <command:parameterValue required="false">ShopOrderLineQuery</command:parameterValue> <dev:type> <maml:name>ShopOrderLineQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PdfDesign</maml:name> <maml:description> <maml:para>Specify the pdf design details to be returned using a pdf design query.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignQuery</command:parameterValue> <dev:type> <maml:name>PdfDesignQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Phase</maml:name> <maml:description> <maml:para>Specify the phase details to be returned using a workflow phase query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowPhaseQuery</command:parameterValue> <dev:type> <maml:name>WorkflowPhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Request</maml:name> <maml:description> <maml:para>Specify the request details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>RequestServiceInstance</maml:name> <maml:description> <maml:para>Specify the request service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>RequestTemplate</maml:name> <maml:description> <maml:para>Specify the request template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SprintBacklogItems</maml:name> <maml:description> <maml:para>Specify the sprint backlog items details to be returned using a sprint backlog item query.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemQuery</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specify the template details to be returned using a task template query.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>TaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>TimeEntries</maml:name> <maml:description> <maml:para>Specify the time entries details to be returned using a time entry query.</maml:para> </maml:description> <command:parameterValue required="false">TimeEntryQuery</command:parameterValue> <dev:type> <maml:name>TimeEntryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Specify the workflow details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TaskQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TaskQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TaskQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the task query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a task properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskField[]</command:parameterValue> <dev:type> <maml:name>TaskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TaskView</command:parameterValue> <dev:type> <maml:name>TaskView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TaskOrderField</command:parameterValue> <dev:type> <maml:name>TaskOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AgileBoardColumn</maml:name> <maml:description> <maml:para>Specify the agile board column details to be returned using an agile board column query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Approvals</maml:name> <maml:description> <maml:para>Specify the approvals details to be returned using a task approval query.</maml:para> </maml:description> <command:parameterValue required="false">TaskApprovalQuery</command:parameterValue> <dev:type> <maml:name>TaskApprovalQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>FailureTask</maml:name> <maml:description> <maml:para>Specify the failure task details to be returned using a task query.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specify the member details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>OrderLine</maml:name> <maml:description> <maml:para>Specify the order line details to be returned using a shop order line query.</maml:para> </maml:description> <command:parameterValue required="false">ShopOrderLineQuery</command:parameterValue> <dev:type> <maml:name>ShopOrderLineQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PdfDesign</maml:name> <maml:description> <maml:para>Specify the pdf design details to be returned using a pdf design query.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignQuery</command:parameterValue> <dev:type> <maml:name>PdfDesignQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Phase</maml:name> <maml:description> <maml:para>Specify the phase details to be returned using a workflow phase query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowPhaseQuery</command:parameterValue> <dev:type> <maml:name>WorkflowPhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Request</maml:name> <maml:description> <maml:para>Specify the request details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>RequestServiceInstance</maml:name> <maml:description> <maml:para>Specify the request service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>RequestTemplate</maml:name> <maml:description> <maml:para>Specify the request template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SprintBacklogItems</maml:name> <maml:description> <maml:para>Specify the sprint backlog items details to be returned using a sprint backlog item query.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemQuery</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specify the template details to be returned using a task template query.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>TaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>TimeEntries</maml:name> <maml:description> <maml:para>Specify the time entries details to be returned using a time entry query.</maml:para> </maml:description> <command:parameterValue required="false">TimeEntryQuery</command:parameterValue> <dev:type> <maml:name>TimeEntryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Specify the workflow details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TaskQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TaskQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TaskQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskField[]</maml:name> </dev:type> <maml:description> <maml:para>The Task field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskView</maml:name> </dev:type> <maml:description> <maml:para>The task view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskOrderField</maml:name> </dev:type> <maml:description> <maml:para>The task order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardColumnQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board column query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskApprovalQuery</maml:name> </dev:type> <maml:description> <maml:para>A task approval query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteQuery</maml:name> </dev:type> <maml:description> <maml:para>A note query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopOrderLineQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop order line query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PdfDesignQuery</maml:name> </dev:type> <maml:description> <maml:para>A pdf design query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowPhaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow phase query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A request template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintBacklogItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A sprint backlog item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A task template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeEntryQuery</maml:name> </dev:type> <maml:description> <maml:para>A time entry query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<TaskQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A task query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A task query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTaskQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentTaskQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new task query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTaskQueryFilter cmdlet creates and configures a task query filter object using the provided parameters. These filters can be used with the New-XurrentTaskQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTaskQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TaskFilter</command:parameterValue> <dev:type> <maml:name>TaskFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TaskFilter</command:parameterValue> <dev:type> <maml:name>TaskFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskFilter</maml:name> </dev:type> <maml:description> <maml:para>a task filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<TaskQuery></maml:name> </dev:type> <maml:description> <maml:para>A task query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTaskTemplate</command:name> <command:verb>New</command:verb> <command:noun>XurrentTaskTemplate</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new task template.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a task template using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTaskTemplate</maml:name> <command:parameter required="true" position="0"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">TaskCategory</command:parameterValue> <dev:type> <maml:name>TaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>The number of minutes that should be entered in the Planned duration field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AssignToRequester</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Requested for field of the request for which the workflow is being generated.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AssignToRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the business unit to which the organization belongs that is linked to the person who is selected in the Requested for field of the request for which the workflow is being generated.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignToRequesterManager</maml:name> <maml:description> <maml:para>Whether the manager of the requester of the first related request is to be selected in the Approver field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AssignToServiceOwner</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Service owner field of the service that is linked to the workflow that the new task is a part of.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AssignToWorkflowManager</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the workflow to which the task belongs.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the task template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CopyNotesToWorkflow</maml:name> <maml:description> <maml:para>Whether the Copy note to workflow box of tasks that were created based on the template needs to be checked by default. (The Copy notes to workflow checkbox is called "Copy notes to workflow by default" when the task template is in Edit mode.)</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the task template may not be used to help register new tasks.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a task created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Impact</maml:name> <maml:description> <maml:para>The impact level that needs to be selected in the Impact field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">TaskImpact</command:parameterValue> <dev:type> <maml:name>TaskImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Instructions field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person who should be selected in the Member field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>NewApprovals</maml:name> <maml:description> <maml:para>Approvals of the task template.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateApprovalInput[]</command:parameterValue> <dev:type> <maml:name>TaskTemplateApprovalInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design that needs to be copied to the PDF design field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>The number of minutes the member is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PlannedEffortRequester</maml:name> <maml:description> <maml:para>The number of minutes the person, who is selected in the Requested for field of the first related request, is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PlannedEffortRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>The number of minutes the business unit manager of the requester of the first related request is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>PlannedEffortRequesterManager</maml:name> <maml:description> <maml:para>The number of minutes the manager of the requester of the first related request is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PlannedEffortServiceOwner</maml:name> <maml:description> <maml:para>The number of minutes the owner of the service of the related to the workflow is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>PlannedEffortWorkflowManager</maml:name> <maml:description> <maml:para>The number of minutes the workflow manager is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>ProviderNotAccountable</maml:name> <maml:description> <maml:para>Default: false - Whether the provider indicates not to be accountable for the affected SLAs linked to the requests that are linked to the workflow of a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>RequestServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the service instance that should be selected in the Request service instance field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>RequestTemplateId</maml:name> <maml:description> <maml:para>Identifier of the request template that should be selected in the Request template field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number that needs to be specified in the Required approvals field of a new approval task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of the service instances of the task template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that should be selected in the Supplier field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team that should be selected in the Team field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether a new task that is created based on the template is to be marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>Whether the completion target of tasks created based on the template are calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="37"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of task template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskTemplateField[]</command:parameterValue> <dev:type> <maml:name>TaskTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">TaskCategory</command:parameterValue> <dev:type> <maml:name>TaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>The number of minutes that should be entered in the Planned duration field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AssignToRequester</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Requested for field of the request for which the workflow is being generated.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AssignToRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the business unit to which the organization belongs that is linked to the person who is selected in the Requested for field of the request for which the workflow is being generated.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignToRequesterManager</maml:name> <maml:description> <maml:para>Whether the manager of the requester of the first related request is to be selected in the Approver field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AssignToServiceOwner</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Service owner field of the service that is linked to the workflow that the new task is a part of.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AssignToWorkflowManager</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the workflow to which the task belongs.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the task template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CopyNotesToWorkflow</maml:name> <maml:description> <maml:para>Whether the Copy note to workflow box of tasks that were created based on the template needs to be checked by default. (The Copy notes to workflow checkbox is called "Copy notes to workflow by default" when the task template is in Edit mode.)</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the task template may not be used to help register new tasks.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a task created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Impact</maml:name> <maml:description> <maml:para>The impact level that needs to be selected in the Impact field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">TaskImpact</command:parameterValue> <dev:type> <maml:name>TaskImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Instructions field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person who should be selected in the Member field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>NewApprovals</maml:name> <maml:description> <maml:para>Approvals of the task template.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateApprovalInput[]</command:parameterValue> <dev:type> <maml:name>TaskTemplateApprovalInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design that needs to be copied to the PDF design field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>The number of minutes the member is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PlannedEffortRequester</maml:name> <maml:description> <maml:para>The number of minutes the person, who is selected in the Requested for field of the first related request, is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PlannedEffortRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>The number of minutes the business unit manager of the requester of the first related request is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>PlannedEffortRequesterManager</maml:name> <maml:description> <maml:para>The number of minutes the manager of the requester of the first related request is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PlannedEffortServiceOwner</maml:name> <maml:description> <maml:para>The number of minutes the owner of the service of the related to the workflow is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>PlannedEffortWorkflowManager</maml:name> <maml:description> <maml:para>The number of minutes the workflow manager is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>ProviderNotAccountable</maml:name> <maml:description> <maml:para>Default: false - Whether the provider indicates not to be accountable for the affected SLAs linked to the requests that are linked to the workflow of a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>RequestServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the service instance that should be selected in the Request service instance field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>RequestTemplateId</maml:name> <maml:description> <maml:para>Identifier of the request template that should be selected in the Request template field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number that needs to be specified in the Required approvals field of a new approval task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of the service instances of the task template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that should be selected in the Supplier field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team that should be selected in the Team field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether a new task that is created based on the template is to be marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>Whether the completion target of tasks created based on the template are calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="37"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of task template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskTemplateField[]</command:parameterValue> <dev:type> <maml:name>TaskTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskCategory</maml:name> </dev:type> <maml:description> <maml:para>A task category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskImpact</maml:name> </dev:type> <maml:description> <maml:para>A task impact object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateApprovalInput[]</maml:name> </dev:type> <maml:description> <maml:para>A task template approval input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The task template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TaskTemplate</maml:name> </dev:type> <maml:description> <maml:para>A task template object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTaskTemplateApprovalQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentTaskTemplateApprovalQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a task template approval query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTaskTemplateApprovalQuery cmdlet creates and configures a task template approval query object using the provided parameters. These result can be used with the Invoke-XurrentTaskTemplateApprovalQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTaskTemplateApprovalQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a task template approval properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskTemplateApprovalField[]</command:parameterValue> <dev:type> <maml:name>TaskTemplateApprovalField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Approver</maml:name> <maml:description> <maml:para>Specify the approver details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a task template approval properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskTemplateApprovalField[]</command:parameterValue> <dev:type> <maml:name>TaskTemplateApprovalField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Approver</maml:name> <maml:description> <maml:para>Specify the approver details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateApprovalField[]</maml:name> </dev:type> <maml:description> <maml:para>The Task template approval field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TaskTemplateApprovalQuery</maml:name> </dev:type> <maml:description> <maml:para>A task template approval query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTaskTemplateQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentTaskTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a task template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTaskTemplateQuery cmdlet creates and configures a task template query object using the provided parameters. These result can be used with the Invoke-XurrentTaskTemplateQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTaskTemplateQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the task template query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a task template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskTemplateField[]</command:parameterValue> <dev:type> <maml:name>TaskTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateView</command:parameterValue> <dev:type> <maml:name>TaskTemplateView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateOrderField</command:parameterValue> <dev:type> <maml:name>TaskTemplateOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Approvals</maml:name> <maml:description> <maml:para>Specify the approvals details to be returned using a task template approval query.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateApprovalQuery</command:parameterValue> <dev:type> <maml:name>TaskTemplateApprovalQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specify the member details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>Specify the note attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PdfDesign</maml:name> <maml:description> <maml:para>Specify the pdf design details to be returned using a pdf design query.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignQuery</command:parameterValue> <dev:type> <maml:name>PdfDesignQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RequestServiceInstance</maml:name> <maml:description> <maml:para>Specify the request service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RequestTemplate</maml:name> <maml:description> <maml:para>Specify the request template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SkillPool</maml:name> <maml:description> <maml:para>Specify the skill pool details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Tasks</maml:name> <maml:description> <maml:para>Specify the tasks details to be returned using a task query.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>WorkflowTemplates</maml:name> <maml:description> <maml:para>Specify the workflow templates details to be returned using a workflow template query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TaskTemplateQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TaskTemplateQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TaskTemplateQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the task template query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a task template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskTemplateField[]</command:parameterValue> <dev:type> <maml:name>TaskTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateView</command:parameterValue> <dev:type> <maml:name>TaskTemplateView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateOrderField</command:parameterValue> <dev:type> <maml:name>TaskTemplateOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Approvals</maml:name> <maml:description> <maml:para>Specify the approvals details to be returned using a task template approval query.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateApprovalQuery</command:parameterValue> <dev:type> <maml:name>TaskTemplateApprovalQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ConfigurationItems</maml:name> <maml:description> <maml:para>Specify the configuration items details to be returned using a configuration item query.</maml:para> </maml:description> <command:parameterValue required="false">ConfigurationItemQuery</command:parameterValue> <dev:type> <maml:name>ConfigurationItemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Member</maml:name> <maml:description> <maml:para>Specify the member details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>Specify the note attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PdfDesign</maml:name> <maml:description> <maml:para>Specify the pdf design details to be returned using a pdf design query.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignQuery</command:parameterValue> <dev:type> <maml:name>PdfDesignQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RequestServiceInstance</maml:name> <maml:description> <maml:para>Specify the request service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RequestTemplate</maml:name> <maml:description> <maml:para>Specify the request template details to be returned using a request template query.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceInstances</maml:name> <maml:description> <maml:para>Specify the service instances details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SkillPool</maml:name> <maml:description> <maml:para>Specify the skill pool details to be returned using a skill pool query.</maml:para> </maml:description> <command:parameterValue required="false">SkillPoolQuery</command:parameterValue> <dev:type> <maml:name>SkillPoolQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Supplier</maml:name> <maml:description> <maml:para>Specify the supplier details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Tasks</maml:name> <maml:description> <maml:para>Specify the tasks details to be returned using a task query.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>WorkflowTemplates</maml:name> <maml:description> <maml:para>Specify the workflow templates details to be returned using a workflow template query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TaskTemplateQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TaskTemplateQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TaskTemplateQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The Task template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateView</maml:name> </dev:type> <maml:description> <maml:para>The task template view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateOrderField</maml:name> </dev:type> <maml:description> <maml:para>The task template order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateApprovalQuery</maml:name> </dev:type> <maml:description> <maml:para>A task template approval query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemQuery</maml:name> </dev:type> <maml:description> <maml:para>A configuration item query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PdfDesignQuery</maml:name> </dev:type> <maml:description> <maml:para>A pdf design query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A request template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolQuery</maml:name> </dev:type> <maml:description> <maml:para>A skill pool query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<TaskTemplateQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A task template query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TaskTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A task template query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTaskTemplateQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentTaskTemplateQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new task template query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTaskTemplateQueryFilter cmdlet creates and configures a task template query filter object using the provided parameters. These filters can be used with the New-XurrentTaskTemplateQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTaskTemplateQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TaskTemplateFilter</command:parameterValue> <dev:type> <maml:name>TaskTemplateFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TaskTemplateFilter</command:parameterValue> <dev:type> <maml:name>TaskTemplateFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateFilter</maml:name> </dev:type> <maml:description> <maml:para>a task template filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<TaskTemplateQuery></maml:name> </dev:type> <maml:description> <maml:para>A task template query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTeam</command:name> <command:verb>New</command:verb> <command:noun>XurrentTeam</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new team.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a team using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTeam</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the team.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>Used to automatically link records to the agile board when they are assigned to the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AutoAssign</maml:name> <maml:description> <maml:para>Whether requests are auto-assigned to a team member.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationManagerId</maml:name> <maml:description> <maml:para>The person who maintains the information about the configuration items that the team supports.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CoordinatorId</maml:name> <maml:description> <maml:para>The current team coordinator for the team. Only members of the team can be selected in this field.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the team may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>InboundEmailLocalPart</maml:name> <maml:description> <maml:para>Used to specify an email address for the team. When an email is sent to this email address, a new request gets generated and assigned to the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager or supervisor of the team. This person is able to maintain the information about the team. The manager of a team does not need to be a member of the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>MemberIds</maml:name> <maml:description> <maml:para>People that are linked as member to the team.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the team that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected work hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>WorkHoursId</maml:name> <maml:description> <maml:para>The calendar that defines the work hours during which the team is available for work on all types of assignments.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="20"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of team properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamField[]</command:parameterValue> <dev:type> <maml:name>TeamField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the team.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>Used to automatically link records to the agile board when they are assigned to the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AutoAssign</maml:name> <maml:description> <maml:para>Whether requests are auto-assigned to a team member.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationManagerId</maml:name> <maml:description> <maml:para>The person who maintains the information about the configuration items that the team supports.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CoordinatorId</maml:name> <maml:description> <maml:para>The current team coordinator for the team. Only members of the team can be selected in this field.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the team may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>InboundEmailLocalPart</maml:name> <maml:description> <maml:para>Used to specify an email address for the team. When an email is sent to this email address, a new request gets generated and assigned to the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager or supervisor of the team. This person is able to maintain the information about the team. The manager of a team does not need to be a member of the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>MemberIds</maml:name> <maml:description> <maml:para>People that are linked as member to the team.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the team that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected work hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>WorkHoursId</maml:name> <maml:description> <maml:para>The calendar that defines the work hours during which the team is available for work on all types of assignments.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="20"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of team properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamField[]</command:parameterValue> <dev:type> <maml:name>TeamField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamField[]</maml:name> </dev:type> <maml:description> <maml:para>The team field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Team</maml:name> </dev:type> <maml:description> <maml:para>A team object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTeamQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentTeamQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a team query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTeamQuery cmdlet creates and configures a team query object using the provided parameters. These result can be used with the Invoke-XurrentTeamQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTeamQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the team query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a team properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamField[]</command:parameterValue> <dev:type> <maml:name>TeamField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TeamView</command:parameterValue> <dev:type> <maml:name>TeamView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TeamOrderField</command:parameterValue> <dev:type> <maml:name>TeamOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationManager</maml:name> <maml:description> <maml:para>Specify the configuration manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Coordinator</maml:name> <maml:description> <maml:para>Specify the coordinator details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Members</maml:name> <maml:description> <maml:para>Specify the members details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ScrumWorkspace</maml:name> <maml:description> <maml:para>Specify the scrum workspace details to be returned using a scrum workspace query.</maml:para> </maml:description> <command:parameterValue required="false">ScrumWorkspaceQuery</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>WorkHours</maml:name> <maml:description> <maml:para>Specify the work hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TeamQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TeamQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TeamQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the team query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a team properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamField[]</command:parameterValue> <dev:type> <maml:name>TeamField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TeamView</command:parameterValue> <dev:type> <maml:name>TeamView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TeamOrderField</command:parameterValue> <dev:type> <maml:name>TeamOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AgileBoard</maml:name> <maml:description> <maml:para>Specify the agile board details to be returned using an agile board query.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardQuery</command:parameterValue> <dev:type> <maml:name>AgileBoardQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationManager</maml:name> <maml:description> <maml:para>Specify the configuration manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Coordinator</maml:name> <maml:description> <maml:para>Specify the coordinator details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Members</maml:name> <maml:description> <maml:para>Specify the members details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Specify the remarks attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ScrumWorkspace</maml:name> <maml:description> <maml:para>Specify the scrum workspace details to be returned using a scrum workspace query.</maml:para> </maml:description> <command:parameterValue required="false">ScrumWorkspaceQuery</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>WorkHours</maml:name> <maml:description> <maml:para>Specify the work hours details to be returned using a calendar query.</maml:para> </maml:description> <command:parameterValue required="false">CalendarQuery</command:parameterValue> <dev:type> <maml:name>CalendarQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TeamQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TeamQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TeamQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamField[]</maml:name> </dev:type> <maml:description> <maml:para>The Team field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamView</maml:name> </dev:type> <maml:description> <maml:para>The team view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamOrderField</maml:name> </dev:type> <maml:description> <maml:para>The team order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardQuery</maml:name> </dev:type> <maml:description> <maml:para>An agile board query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ScrumWorkspaceQuery</maml:name> </dev:type> <maml:description> <maml:para>A scrum workspace query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarQuery</maml:name> </dev:type> <maml:description> <maml:para>A calendar query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<TeamQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A team query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTeamQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentTeamQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new team query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTeamQueryFilter cmdlet creates and configures a team query filter object using the provided parameters. These filters can be used with the New-XurrentTeamQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTeamQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TeamFilter</command:parameterValue> <dev:type> <maml:name>TeamFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TeamFilter</command:parameterValue> <dev:type> <maml:name>TeamFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamFilter</maml:name> </dev:type> <maml:description> <maml:para>a team filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<TeamQuery></maml:name> </dev:type> <maml:description> <maml:para>A team query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTimeAllocation</command:name> <command:verb>New</command:verb> <command:noun>XurrentTimeAllocation</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new time allocation.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a time allocation using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTimeAllocation</maml:name> <command:parameter required="true" position="0"> <maml:name>CustomerCategory</maml:name> <maml:description> <maml:para>Whether a person who spent on the time allocation needs to select a customer organization, and if this is the case, whether this person may only select from the customer organizations linked to the time allocation or is allowed to select any customer organization.</maml:para> </maml:description> <command:parameterValue required="true">TimeAllocationCustomerCategory</command:parameterValue> <dev:type> <maml:name>TimeAllocationCustomerCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>DescriptionCategory</maml:name> <maml:description> <maml:para>Whether the Description field should be available, and if so, whether it should be required, in the time entries to which the time allocation is related.</maml:para> </maml:description> <command:parameterValue required="true">TimeAllocationDescriptionCategory</command:parameterValue> <dev:type> <maml:name>TimeAllocationDescriptionCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the time allocation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>ServiceCategory</maml:name> <maml:description> <maml:para>Whether a Person who spent on the time allocation needs to select a service, and if this is the case, whether this person may only select from the services linked to the time allocation or is allowed to select any service.</maml:para> </maml:description> <command:parameterValue required="true">TimeAllocationServiceCategory</command:parameterValue> <dev:type> <maml:name>TimeAllocationServiceCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomerIds</maml:name> <maml:description> <maml:para>Identifiers of the customer organizations of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the time allocation may no longer be related to any more organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on this time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Group</maml:name> <maml:description> <maml:para>Which group to include the time allocation in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of the organizations of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServiceIds</maml:name> <maml:description> <maml:para>Identifiers of the services of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of time allocation properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimeAllocationField[]</command:parameterValue> <dev:type> <maml:name>TimeAllocationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>CustomerCategory</maml:name> <maml:description> <maml:para>Whether a person who spent on the time allocation needs to select a customer organization, and if this is the case, whether this person may only select from the customer organizations linked to the time allocation or is allowed to select any customer organization.</maml:para> </maml:description> <command:parameterValue required="true">TimeAllocationCustomerCategory</command:parameterValue> <dev:type> <maml:name>TimeAllocationCustomerCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>DescriptionCategory</maml:name> <maml:description> <maml:para>Whether the Description field should be available, and if so, whether it should be required, in the time entries to which the time allocation is related.</maml:para> </maml:description> <command:parameterValue required="true">TimeAllocationDescriptionCategory</command:parameterValue> <dev:type> <maml:name>TimeAllocationDescriptionCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the time allocation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>ServiceCategory</maml:name> <maml:description> <maml:para>Whether a Person who spent on the time allocation needs to select a service, and if this is the case, whether this person may only select from the services linked to the time allocation or is allowed to select any service.</maml:para> </maml:description> <command:parameterValue required="true">TimeAllocationServiceCategory</command:parameterValue> <dev:type> <maml:name>TimeAllocationServiceCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomerIds</maml:name> <maml:description> <maml:para>Identifiers of the customer organizations of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the time allocation may no longer be related to any more organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on this time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Group</maml:name> <maml:description> <maml:para>Which group to include the time allocation in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of the organizations of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServiceIds</maml:name> <maml:description> <maml:para>Identifiers of the services of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of time allocation properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimeAllocationField[]</command:parameterValue> <dev:type> <maml:name>TimeAllocationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationCustomerCategory</maml:name> </dev:type> <maml:description> <maml:para>A time allocation customer category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationDescriptionCategory</maml:name> </dev:type> <maml:description> <maml:para>A time allocation description category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationServiceCategory</maml:name> </dev:type> <maml:description> <maml:para>A time allocation service category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationField[]</maml:name> </dev:type> <maml:description> <maml:para>The time allocation field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TimeAllocation</maml:name> </dev:type> <maml:description> <maml:para>A time allocation object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTimeAllocationQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentTimeAllocationQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a time allocation query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTimeAllocationQuery cmdlet creates and configures a time allocation query object using the provided parameters. These result can be used with the Invoke-XurrentTimeAllocationQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTimeAllocationQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the time allocation query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a time allocation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimeAllocationField[]</command:parameterValue> <dev:type> <maml:name>TimeAllocationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationView</command:parameterValue> <dev:type> <maml:name>TimeAllocationView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationOrderField</command:parameterValue> <dev:type> <maml:name>TimeAllocationOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Customers</maml:name> <maml:description> <maml:para>Specify the customers details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Organizations</maml:name> <maml:description> <maml:para>Specify the organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Services</maml:name> <maml:description> <maml:para>Specify the services details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TimeAllocationQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TimeAllocationQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TimeAllocationQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the time allocation query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a time allocation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimeAllocationField[]</command:parameterValue> <dev:type> <maml:name>TimeAllocationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationView</command:parameterValue> <dev:type> <maml:name>TimeAllocationView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationOrderField</command:parameterValue> <dev:type> <maml:name>TimeAllocationOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Customers</maml:name> <maml:description> <maml:para>Specify the customers details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Organizations</maml:name> <maml:description> <maml:para>Specify the organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Services</maml:name> <maml:description> <maml:para>Specify the services details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TimeAllocationQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TimeAllocationQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TimeAllocationQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationField[]</maml:name> </dev:type> <maml:description> <maml:para>The Time allocation field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationView</maml:name> </dev:type> <maml:description> <maml:para>The time allocation view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationOrderField</maml:name> </dev:type> <maml:description> <maml:para>The time allocation order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<TimeAllocationQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A time allocation query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TimeAllocationQuery</maml:name> </dev:type> <maml:description> <maml:para>A time allocation query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTimeAllocationQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentTimeAllocationQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new time allocation query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTimeAllocationQueryFilter cmdlet creates and configures a time allocation query filter object using the provided parameters. These filters can be used with the New-XurrentTimeAllocationQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTimeAllocationQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TimeAllocationFilter</command:parameterValue> <dev:type> <maml:name>TimeAllocationFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TimeAllocationFilter</command:parameterValue> <dev:type> <maml:name>TimeAllocationFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationFilter</maml:name> </dev:type> <maml:description> <maml:para>a time allocation filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<TimeAllocationQuery></maml:name> </dev:type> <maml:description> <maml:para>A time allocation query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTimeEntry</command:name> <command:verb>New</command:verb> <command:noun>XurrentTimeEntry</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new time entry.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a time entry using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTimeEntry</maml:name> <command:parameter required="true" position="0"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The number of minutes that was spent on the selected time allocation. The number of minutes is allowed to be negative only when the correction field is set to true.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Correction</maml:name> <maml:description> <maml:para>Whether the time entry should be considered a correction for a time entry that was registered for a date that has already been locked.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization for which the time was spent.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Date</maml:name> <maml:description> <maml:para>The date on which the time was spent.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Automatically checked after the time entry has been deleted. The data of a deleted time entry that is older than 3 months can no longer be retrieved.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>A short description of the time spent. This field is available and required only when the Description required box is checked in the selected time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>NoteId</maml:name> <maml:description> <maml:para>Identifier of the note the time entry is linked to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>Identifier of the organization to which the person was linked when the time entry was created.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person who spent the time.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the time was spent.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>StartedAt</maml:name> <maml:description> <maml:para>The start time of the work.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team the person of the time entry was a member of while the work was performed.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>TimeAllocationId</maml:name> <maml:description> <maml:para>Identifier of the time allocation on which the time was spent. Only the time allocations that are linked to the person’s organization can be selected.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="17"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of time entry properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimeEntryField[]</command:parameterValue> <dev:type> <maml:name>TimeEntryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The number of minutes that was spent on the selected time allocation. The number of minutes is allowed to be negative only when the correction field is set to true.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Correction</maml:name> <maml:description> <maml:para>Whether the time entry should be considered a correction for a time entry that was registered for a date that has already been locked.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization for which the time was spent.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Date</maml:name> <maml:description> <maml:para>The date on which the time was spent.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Automatically checked after the time entry has been deleted. The data of a deleted time entry that is older than 3 months can no longer be retrieved.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>A short description of the time spent. This field is available and required only when the Description required box is checked in the selected time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>NoteId</maml:name> <maml:description> <maml:para>Identifier of the note the time entry is linked to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>Identifier of the organization to which the person was linked when the time entry was created.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person who spent the time.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the time was spent.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>StartedAt</maml:name> <maml:description> <maml:para>The start time of the work.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team the person of the time entry was a member of while the work was performed.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>TimeAllocationId</maml:name> <maml:description> <maml:para>Identifier of the time allocation on which the time was spent. Only the time allocations that are linked to the person’s organization can be selected.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="17"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of time entry properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimeEntryField[]</command:parameterValue> <dev:type> <maml:name>TimeEntryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeEntryField[]</maml:name> </dev:type> <maml:description> <maml:para>The time entry field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TimeEntry</maml:name> </dev:type> <maml:description> <maml:para>A time entry object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTimeEntryQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentTimeEntryQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a time entry query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTimeEntryQuery cmdlet creates and configures a time entry query object using the provided parameters. These result can be used with the Invoke-XurrentTimeEntryQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTimeEntryQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the time entry query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a time entry properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimeEntryField[]</command:parameterValue> <dev:type> <maml:name>TimeEntryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TimeEntryView</command:parameterValue> <dev:type> <maml:name>TimeEntryView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TimeEntryOrderField</command:parameterValue> <dev:type> <maml:name>TimeEntryOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AssignmentProblem</maml:name> <maml:description> <maml:para>Specify the assignment Problem to be returned using a problem query. This only applies if the item is a problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AssignmentProjectTask</maml:name> <maml:description> <maml:para>Specify the assignment Project task to be returned using a project task query. This only applies if the item is a project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>AssignmentRequest</maml:name> <maml:description> <maml:para>Specify the assignment Request to be returned using a request query. This only applies if the item is a request.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>AssignmentTask</maml:name> <maml:description> <maml:para>Specify the assignment Task to be returned using a task query. This only applies if the item is a task.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Customer</maml:name> <maml:description> <maml:para>Specify the customer details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Note</maml:name> <maml:description> <maml:para>Specify the note details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Specify the organization details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceLevelAgreement</maml:name> <maml:description> <maml:para>Specify the service level agreement details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TimeAllocation</maml:name> <maml:description> <maml:para>Specify the time allocation details to be returned using a time allocation query.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationQuery</command:parameterValue> <dev:type> <maml:name>TimeAllocationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TimeEntryQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TimeEntryQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TimeEntryQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the time entry query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a time entry properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimeEntryField[]</command:parameterValue> <dev:type> <maml:name>TimeEntryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TimeEntryView</command:parameterValue> <dev:type> <maml:name>TimeEntryView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TimeEntryOrderField</command:parameterValue> <dev:type> <maml:name>TimeEntryOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AssignmentProblem</maml:name> <maml:description> <maml:para>Specify the assignment Problem to be returned using a problem query. This only applies if the item is a problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AssignmentProjectTask</maml:name> <maml:description> <maml:para>Specify the assignment Project task to be returned using a project task query. This only applies if the item is a project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>AssignmentRequest</maml:name> <maml:description> <maml:para>Specify the assignment Request to be returned using a request query. This only applies if the item is a request.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>AssignmentTask</maml:name> <maml:description> <maml:para>Specify the assignment Task to be returned using a task query. This only applies if the item is a task.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Customer</maml:name> <maml:description> <maml:para>Specify the customer details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>EffortClass</maml:name> <maml:description> <maml:para>Specify the effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Note</maml:name> <maml:description> <maml:para>Specify the note details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Specify the organization details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceInstance</maml:name> <maml:description> <maml:para>Specify the service instance details to be returned using a service instance query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceLevelAgreement</maml:name> <maml:description> <maml:para>Specify the service level agreement details to be returned using a service level agreement query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceLevelAgreementQuery</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the team details to be returned using a team query.</maml:para> </maml:description> <command:parameterValue required="false">TeamQuery</command:parameterValue> <dev:type> <maml:name>TeamQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TimeAllocation</maml:name> <maml:description> <maml:para>Specify the time allocation details to be returned using a time allocation query.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationQuery</command:parameterValue> <dev:type> <maml:name>TimeAllocationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TimeEntryQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TimeEntryQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TimeEntryQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeEntryField[]</maml:name> </dev:type> <maml:description> <maml:para>The Time entry field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeEntryView</maml:name> </dev:type> <maml:description> <maml:para>The time entry view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeEntryOrderField</maml:name> </dev:type> <maml:description> <maml:para>The time entry order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemQuery</maml:name> </dev:type> <maml:description> <maml:para>A problem query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteQuery</maml:name> </dev:type> <maml:description> <maml:para>A note query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementQuery</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamQuery</maml:name> </dev:type> <maml:description> <maml:para>A team query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationQuery</maml:name> </dev:type> <maml:description> <maml:para>A time allocation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<TimeEntryQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A time entry query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TimeEntryQuery</maml:name> </dev:type> <maml:description> <maml:para>A time entry query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTimeEntryQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentTimeEntryQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new time entry query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTimeEntryQueryFilter cmdlet creates and configures a time entry query filter object using the provided parameters. These filters can be used with the New-XurrentTimeEntryQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTimeEntryQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TimeEntryFilter</command:parameterValue> <dev:type> <maml:name>TimeEntryFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TimeEntryFilter</command:parameterValue> <dev:type> <maml:name>TimeEntryFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeEntryFilter</maml:name> </dev:type> <maml:description> <maml:para>a time entry filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<TimeEntryQuery></maml:name> </dev:type> <maml:description> <maml:para>A time entry query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTimesheetSetting</command:name> <command:verb>New</command:verb> <command:noun>XurrentTimesheetSetting</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new timesheet setting.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a timesheet setting using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTimesheetSetting</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the timesheet settings.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Unit</maml:name> <maml:description> <maml:para>Whether the people of the organizations to which the timesheet settings are linked need to register their time in hours and minutes, or as a percentage of a workday.</maml:para> </maml:description> <command:parameterValue required="true">TimesheetSettingUnit</command:parameterValue> <dev:type> <maml:name>TimesheetSettingUnit</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AllocationTimeTracking</maml:name> <maml:description> <maml:para>Whether people of the related organizations need to be able to register time entries for the time allocations that are linked to their organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AllowWorkdayOvertime</maml:name> <maml:description> <maml:para>Whether the people of the organizations to which the timesheet settings are linked are allowed to register more time for a single day than the amount of time specified in the Workday field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AllowWorkweekOvertime</maml:name> <maml:description> <maml:para>Whether the people of the organizations to which the timesheet settings are linked are allowed to register more time for a single week than the amount of time specified in the Workweek field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignmentTimeTracking</maml:name> <maml:description> <maml:para>Whether the Time spent field needs to be available in requests, problems and tasks for specialists of the related organizations to specify how long they have worked on their assignments.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the timesheet settings may no longer be related to any more organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>EffortClassIds</maml:name> <maml:description> <maml:para>Identifiers of effort classes of the timesheet setting.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>NotifyOnIncomplete</maml:name> <maml:description> <maml:para>Whether an email notification should be sent to each person who registered fewer hours for the past week than the workweek hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of organizations of the timesheet setting.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>PercentageIncrement</maml:name> <maml:description> <maml:para>The minimum amount percentage of a workday that the people of the organizations to which the timesheet settings are linked can select when they register a time entry. This percentage of a workday is also the increment by which they can increase this minimum percentage of a workday.</maml:para> </maml:description> <command:parameterValue required="false">TimesheetSettingPercentageIncrement</command:parameterValue> <dev:type> <maml:name>TimesheetSettingPercentageIncrement</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ProblemEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ProjectTaskEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RequestEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RequireNote</maml:name> <maml:description> <maml:para>Whether the Note field needs to become required, when someone in an organization linked to the timesheet settings registers time on a request, problem or task.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>TaskEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a workflow task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>TimeAllocationEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TimeIncrement</maml:name> <maml:description> <maml:para>The minimum amount of time that the people of the organizations to which the timesheet settings are linked can select when they register a time entry. This amount of time is also the increment by which they can increase this minimum amount of time.</maml:para> </maml:description> <command:parameterValue required="false">TimesheetSettingTimeIncrement</command:parameterValue> <dev:type> <maml:name>TimesheetSettingTimeIncrement</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Workday</maml:name> <maml:description> <maml:para>The duration of a workday in minutes.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Workweek</maml:name> <maml:description> <maml:para>The duration of a workweek in minutes.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="23"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of timesheet setting properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimesheetSettingField[]</command:parameterValue> <dev:type> <maml:name>TimesheetSettingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the timesheet settings.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Unit</maml:name> <maml:description> <maml:para>Whether the people of the organizations to which the timesheet settings are linked need to register their time in hours and minutes, or as a percentage of a workday.</maml:para> </maml:description> <command:parameterValue required="true">TimesheetSettingUnit</command:parameterValue> <dev:type> <maml:name>TimesheetSettingUnit</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AllocationTimeTracking</maml:name> <maml:description> <maml:para>Whether people of the related organizations need to be able to register time entries for the time allocations that are linked to their organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AllowWorkdayOvertime</maml:name> <maml:description> <maml:para>Whether the people of the organizations to which the timesheet settings are linked are allowed to register more time for a single day than the amount of time specified in the Workday field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AllowWorkweekOvertime</maml:name> <maml:description> <maml:para>Whether the people of the organizations to which the timesheet settings are linked are allowed to register more time for a single week than the amount of time specified in the Workweek field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignmentTimeTracking</maml:name> <maml:description> <maml:para>Whether the Time spent field needs to be available in requests, problems and tasks for specialists of the related organizations to specify how long they have worked on their assignments.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the timesheet settings may no longer be related to any more organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>EffortClassIds</maml:name> <maml:description> <maml:para>Identifiers of effort classes of the timesheet setting.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>NotifyOnIncomplete</maml:name> <maml:description> <maml:para>Whether an email notification should be sent to each person who registered fewer hours for the past week than the workweek hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of organizations of the timesheet setting.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>PercentageIncrement</maml:name> <maml:description> <maml:para>The minimum amount percentage of a workday that the people of the organizations to which the timesheet settings are linked can select when they register a time entry. This percentage of a workday is also the increment by which they can increase this minimum percentage of a workday.</maml:para> </maml:description> <command:parameterValue required="false">TimesheetSettingPercentageIncrement</command:parameterValue> <dev:type> <maml:name>TimesheetSettingPercentageIncrement</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ProblemEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ProjectTaskEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RequestEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RequireNote</maml:name> <maml:description> <maml:para>Whether the Note field needs to become required, when someone in an organization linked to the timesheet settings registers time on a request, problem or task.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>TaskEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a workflow task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>TimeAllocationEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TimeIncrement</maml:name> <maml:description> <maml:para>The minimum amount of time that the people of the organizations to which the timesheet settings are linked can select when they register a time entry. This amount of time is also the increment by which they can increase this minimum amount of time.</maml:para> </maml:description> <command:parameterValue required="false">TimesheetSettingTimeIncrement</command:parameterValue> <dev:type> <maml:name>TimesheetSettingTimeIncrement</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Workday</maml:name> <maml:description> <maml:para>The duration of a workday in minutes.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Workweek</maml:name> <maml:description> <maml:para>The duration of a workweek in minutes.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="23"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of timesheet setting properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimesheetSettingField[]</command:parameterValue> <dev:type> <maml:name>TimesheetSettingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimesheetSettingUnit</maml:name> </dev:type> <maml:description> <maml:para>A timesheet setting unit object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimesheetSettingPercentageIncrement</maml:name> </dev:type> <maml:description> <maml:para>A timesheet setting percentage increment object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimesheetSettingTimeIncrement</maml:name> </dev:type> <maml:description> <maml:para>A timesheet setting time increment object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimesheetSettingField[]</maml:name> </dev:type> <maml:description> <maml:para>The timesheet setting field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TimesheetSetting</maml:name> </dev:type> <maml:description> <maml:para>A timesheet setting object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTimesheetSettingQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentTimesheetSettingQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a timesheet setting query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTimesheetSettingQuery cmdlet creates and configures a timesheet setting query object using the provided parameters. These result can be used with the Invoke-XurrentTimesheetSettingQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTimesheetSettingQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the timesheet setting query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a timesheet setting properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimesheetSettingField[]</command:parameterValue> <dev:type> <maml:name>TimesheetSettingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClasses</maml:name> <maml:description> <maml:para>Specify the effort classes details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Organizations</maml:name> <maml:description> <maml:para>Specify the organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ProblemEffortClass</maml:name> <maml:description> <maml:para>Specify the problem effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ProjectTaskEffortClass</maml:name> <maml:description> <maml:para>Specify the project task effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RequestEffortClass</maml:name> <maml:description> <maml:para>Specify the request effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>TaskEffortClass</maml:name> <maml:description> <maml:para>Specify the task effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>TimeAllocationEffortClass</maml:name> <maml:description> <maml:para>Specify the time allocation effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TimesheetSettingQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TimesheetSettingQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TimesheetSettingQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the timesheet setting query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a timesheet setting properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimesheetSettingField[]</command:parameterValue> <dev:type> <maml:name>TimesheetSettingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClasses</maml:name> <maml:description> <maml:para>Specify the effort classes details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Organizations</maml:name> <maml:description> <maml:para>Specify the organizations details to be returned using an organization query.</maml:para> </maml:description> <command:parameterValue required="false">OrganizationQuery</command:parameterValue> <dev:type> <maml:name>OrganizationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ProblemEffortClass</maml:name> <maml:description> <maml:para>Specify the problem effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ProjectTaskEffortClass</maml:name> <maml:description> <maml:para>Specify the project task effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RequestEffortClass</maml:name> <maml:description> <maml:para>Specify the request effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>TaskEffortClass</maml:name> <maml:description> <maml:para>Specify the task effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>TimeAllocationEffortClass</maml:name> <maml:description> <maml:para>Specify the time allocation effort class details to be returned using an effort class query.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassQuery</command:parameterValue> <dev:type> <maml:name>EffortClassQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TimesheetSettingQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TimesheetSettingQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TimesheetSettingQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimesheetSettingField[]</maml:name> </dev:type> <maml:description> <maml:para>The Timesheet setting field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassQuery</maml:name> </dev:type> <maml:description> <maml:para>An effort class query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationQuery</maml:name> </dev:type> <maml:description> <maml:para>An organization query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<TimesheetSettingQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A timesheet setting query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TimesheetSettingQuery</maml:name> </dev:type> <maml:description> <maml:para>A timesheet setting query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTimesheetSettingQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentTimesheetSettingQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new timesheet setting query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTimesheetSettingQueryFilter cmdlet creates and configures a timesheet setting query filter object using the provided parameters. These filters can be used with the New-XurrentTimesheetSettingQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTimesheetSettingQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TimesheetSettingFilter</command:parameterValue> <dev:type> <maml:name>TimesheetSettingFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TimesheetSettingFilter</command:parameterValue> <dev:type> <maml:name>TimesheetSettingFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimesheetSettingFilter</maml:name> </dev:type> <maml:description> <maml:para>a timesheet setting filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<TimesheetSettingQuery></maml:name> </dev:type> <maml:description> <maml:para>A timesheet setting query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTranslation</command:name> <command:verb>New</command:verb> <command:noun>XurrentTranslation</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new translation.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a translation using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTranslation</maml:name> <command:parameter required="true" position="0"> <maml:name>Field</maml:name> <maml:description> <maml:para>The field of the record from which the translation is obtained.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Language</maml:name> <maml:description> <maml:para>The language in which the text is specified.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>The record from which the translation is obtained.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Text</maml:name> <maml:description> <maml:para>The text of the translation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of translation properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TranslationField[]</command:parameterValue> <dev:type> <maml:name>TranslationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Field</maml:name> <maml:description> <maml:para>The field of the record from which the translation is obtained.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Language</maml:name> <maml:description> <maml:para>The language in which the text is specified.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>The record from which the translation is obtained.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Text</maml:name> <maml:description> <maml:para>The text of the translation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of translation properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TranslationField[]</command:parameterValue> <dev:type> <maml:name>TranslationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationField[]</maml:name> </dev:type> <maml:description> <maml:para>The translation field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Translation</maml:name> </dev:type> <maml:description> <maml:para>A translation object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTranslationQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentTranslationQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a translation query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTranslationQuery cmdlet creates and configures a translation query object using the provided parameters. These result can be used with the Invoke-XurrentTranslationQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTranslationQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the translation query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a translation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TranslationField[]</command:parameterValue> <dev:type> <maml:name>TranslationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TranslationView</command:parameterValue> <dev:type> <maml:name>TranslationView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TranslationOrderField</command:parameterValue> <dev:type> <maml:name>TranslationOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>OwnerCustomCollectionElement</maml:name> <maml:description> <maml:para>Specify the owner Custom collection element to be returned using a custom collection element query. This only applies if the item is a custom collection element.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionElementQuery</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>OwnerEmailTemplate</maml:name> <maml:description> <maml:para>Specify the owner Email template to be returned using an email template query. This only applies if the item is an email template.</maml:para> </maml:description> <command:parameterValue required="false">EmailTemplateQuery</command:parameterValue> <dev:type> <maml:name>EmailTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OwnerKnowledgeArticle</maml:name> <maml:description> <maml:para>Specify the owner Knowledge article to be returned using a knowledge article query. This only applies if the item is a knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>OwnerPdfDesign</maml:name> <maml:description> <maml:para>Specify the owner Pdf design to be returned using a pdf design query. This only applies if the item is a pdf design.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignQuery</command:parameterValue> <dev:type> <maml:name>PdfDesignQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>OwnerProductCategory</maml:name> <maml:description> <maml:para>Specify the owner Product category to be returned using a product category query. This only applies if the item is a product category.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryQuery</command:parameterValue> <dev:type> <maml:name>ProductCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>OwnerRequestTemplate</maml:name> <maml:description> <maml:para>Specify the owner Request template to be returned using a request template query. This only applies if the item is a request template.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>OwnerRiskSeverity</maml:name> <maml:description> <maml:para>Specify the owner Risk severity to be returned using a risk severity query. This only applies if the item is a risk severity.</maml:para> </maml:description> <command:parameterValue required="false">RiskSeverityQuery</command:parameterValue> <dev:type> <maml:name>RiskSeverityQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>OwnerServiceCategory</maml:name> <maml:description> <maml:para>Specify the owner Service category to be returned using a service category query. This only applies if the item is a service category.</maml:para> </maml:description> <command:parameterValue required="false">ServiceCategoryQuery</command:parameterValue> <dev:type> <maml:name>ServiceCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>OwnerServiceInstance</maml:name> <maml:description> <maml:para>Specify the owner Service instance to be returned using a service instance query. This only applies if the item is a service instance.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>OwnerService</maml:name> <maml:description> <maml:para>Specify the owner Service to be returned using a service query. This only applies if the item is a service.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>OwnerShopArticleCategory</maml:name> <maml:description> <maml:para>Specify the owner Shop article category to be returned using a shop article category query. This only applies if the item is a shop article category.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleCategoryQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>OwnerShopArticle</maml:name> <maml:description> <maml:para>Specify the owner Shop article to be returned using a shop article query. This only applies if the item is a shop article.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>OwnerSurvey</maml:name> <maml:description> <maml:para>Specify the owner Survey to be returned using a survey query. This only applies if the item is a survey.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>OwnerSurveyQuestion</maml:name> <maml:description> <maml:para>Specify the owner Survey question to be returned using a survey question query. This only applies if the item is a survey question.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuestionQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuestionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>OwnerTimeAllocation</maml:name> <maml:description> <maml:para>Specify the owner Time allocation to be returned using a time allocation query. This only applies if the item is a time allocation.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationQuery</command:parameterValue> <dev:type> <maml:name>TimeAllocationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>OwnerUiExtension</maml:name> <maml:description> <maml:para>Specify the owner UI extension to be returned using an user interface extension query. This only applies if the item is an UI extension.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>OwnerWorkflowTemplatePhase</maml:name> <maml:description> <maml:para>Specify the owner Workflow template phase to be returned using a workflow template phase query. This only applies if the item is a workflow template phase.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplatePhaseQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplatePhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>OwnerWorkflowType</maml:name> <maml:description> <maml:para>Specify the owner Workflow type to be returned using a workflow type query. This only applies if the item is a workflow type.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTypeQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTypeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TranslationQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TranslationQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TranslationQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the translation query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a translation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TranslationField[]</command:parameterValue> <dev:type> <maml:name>TranslationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TranslationView</command:parameterValue> <dev:type> <maml:name>TranslationView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TranslationOrderField</command:parameterValue> <dev:type> <maml:name>TranslationOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>OwnerCustomCollectionElement</maml:name> <maml:description> <maml:para>Specify the owner Custom collection element to be returned using a custom collection element query. This only applies if the item is a custom collection element.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionElementQuery</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>OwnerEmailTemplate</maml:name> <maml:description> <maml:para>Specify the owner Email template to be returned using an email template query. This only applies if the item is an email template.</maml:para> </maml:description> <command:parameterValue required="false">EmailTemplateQuery</command:parameterValue> <dev:type> <maml:name>EmailTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OwnerKnowledgeArticle</maml:name> <maml:description> <maml:para>Specify the owner Knowledge article to be returned using a knowledge article query. This only applies if the item is a knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleQuery</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>OwnerPdfDesign</maml:name> <maml:description> <maml:para>Specify the owner Pdf design to be returned using a pdf design query. This only applies if the item is a pdf design.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignQuery</command:parameterValue> <dev:type> <maml:name>PdfDesignQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>OwnerProductCategory</maml:name> <maml:description> <maml:para>Specify the owner Product category to be returned using a product category query. This only applies if the item is a product category.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryQuery</command:parameterValue> <dev:type> <maml:name>ProductCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>OwnerRequestTemplate</maml:name> <maml:description> <maml:para>Specify the owner Request template to be returned using a request template query. This only applies if the item is a request template.</maml:para> </maml:description> <command:parameterValue required="false">RequestTemplateQuery</command:parameterValue> <dev:type> <maml:name>RequestTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>OwnerRiskSeverity</maml:name> <maml:description> <maml:para>Specify the owner Risk severity to be returned using a risk severity query. This only applies if the item is a risk severity.</maml:para> </maml:description> <command:parameterValue required="false">RiskSeverityQuery</command:parameterValue> <dev:type> <maml:name>RiskSeverityQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>OwnerServiceCategory</maml:name> <maml:description> <maml:para>Specify the owner Service category to be returned using a service category query. This only applies if the item is a service category.</maml:para> </maml:description> <command:parameterValue required="false">ServiceCategoryQuery</command:parameterValue> <dev:type> <maml:name>ServiceCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>OwnerServiceInstance</maml:name> <maml:description> <maml:para>Specify the owner Service instance to be returned using a service instance query. This only applies if the item is a service instance.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceQuery</command:parameterValue> <dev:type> <maml:name>ServiceInstanceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>OwnerService</maml:name> <maml:description> <maml:para>Specify the owner Service to be returned using a service query. This only applies if the item is a service.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>OwnerShopArticleCategory</maml:name> <maml:description> <maml:para>Specify the owner Shop article category to be returned using a shop article category query. This only applies if the item is a shop article category.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleCategoryQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>OwnerShopArticle</maml:name> <maml:description> <maml:para>Specify the owner Shop article to be returned using a shop article query. This only applies if the item is a shop article.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleQuery</command:parameterValue> <dev:type> <maml:name>ShopArticleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>OwnerSurvey</maml:name> <maml:description> <maml:para>Specify the owner Survey to be returned using a survey query. This only applies if the item is a survey.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>OwnerSurveyQuestion</maml:name> <maml:description> <maml:para>Specify the owner Survey question to be returned using a survey question query. This only applies if the item is a survey question.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuestionQuery</command:parameterValue> <dev:type> <maml:name>SurveyQuestionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>OwnerTimeAllocation</maml:name> <maml:description> <maml:para>Specify the owner Time allocation to be returned using a time allocation query. This only applies if the item is a time allocation.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationQuery</command:parameterValue> <dev:type> <maml:name>TimeAllocationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>OwnerUiExtension</maml:name> <maml:description> <maml:para>Specify the owner UI extension to be returned using an user interface extension query. This only applies if the item is an UI extension.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>OwnerWorkflowTemplatePhase</maml:name> <maml:description> <maml:para>Specify the owner Workflow template phase to be returned using a workflow template phase query. This only applies if the item is a workflow template phase.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplatePhaseQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplatePhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>OwnerWorkflowType</maml:name> <maml:description> <maml:para>Specify the owner Workflow type to be returned using a workflow type query. This only applies if the item is a workflow type.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTypeQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTypeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TranslationQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TranslationQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TranslationQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationField[]</maml:name> </dev:type> <maml:description> <maml:para>The Translation field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationView</maml:name> </dev:type> <maml:description> <maml:para>The translation view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationOrderField</maml:name> </dev:type> <maml:description> <maml:para>The translation order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionElementQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom collection element query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EmailTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>An email template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleQuery</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PdfDesignQuery</maml:name> </dev:type> <maml:description> <maml:para>A pdf design query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A product category query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A request template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskSeverityQuery</maml:name> </dev:type> <maml:description> <maml:para>A risk severity query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A service category query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service instance query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleCategoryQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop article category query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleQuery</maml:name> </dev:type> <maml:description> <maml:para>A shop article query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyQuestionQuery</maml:name> </dev:type> <maml:description> <maml:para>A survey question query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationQuery</maml:name> </dev:type> <maml:description> <maml:para>A time allocation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplatePhaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow template phase query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTypeQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow type query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<TranslationQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A translation query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTranslationQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentTranslationQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new translation query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTranslationQueryFilter cmdlet creates and configures a translation query filter object using the provided parameters. These filters can be used with the New-XurrentTranslationQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTranslationQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TranslationFilter</command:parameterValue> <dev:type> <maml:name>TranslationFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TranslationFilter</command:parameterValue> <dev:type> <maml:name>TranslationFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationFilter</maml:name> </dev:type> <maml:description> <maml:para>a translation filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<TranslationQuery></maml:name> </dev:type> <maml:description> <maml:para>A translation query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTrashQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentTrashQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a trash query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTrashQuery cmdlet creates and configures a trash query object using the provided parameters. These result can be used with the Invoke-XurrentTrashQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTrashQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the trash query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a trash properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TrashField[]</command:parameterValue> <dev:type> <maml:name>TrashField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TrashView</command:parameterValue> <dev:type> <maml:name>TrashView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TrashOrderField</command:parameterValue> <dev:type> <maml:name>TrashOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>TrashedPerson</maml:name> <maml:description> <maml:para>Specify the trashed Person to be returned using a person query. This only applies if the item is a person.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>TrashedProblem</maml:name> <maml:description> <maml:para>Specify the trashed Problem to be returned using a problem query. This only applies if the item is a problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>TrashedProject</maml:name> <maml:description> <maml:para>Specify the trashed Project to be returned using a project query. This only applies if the item is a project.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>TrashedProjectTask</maml:name> <maml:description> <maml:para>Specify the trashed Project task to be returned using a project task query. This only applies if the item is a project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>TrashedRelease</maml:name> <maml:description> <maml:para>Specify the trashed Release to be returned using a release query. This only applies if the item is a release.</maml:para> </maml:description> <command:parameterValue required="false">ReleaseQuery</command:parameterValue> <dev:type> <maml:name>ReleaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>TrashedRequest</maml:name> <maml:description> <maml:para>Specify the trashed Request to be returned using a request query. This only applies if the item is a request.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>TrashedRisk</maml:name> <maml:description> <maml:para>Specify the trashed Risk to be returned using a risk query. This only applies if the item is a risk.</maml:para> </maml:description> <command:parameterValue required="false">RiskQuery</command:parameterValue> <dev:type> <maml:name>RiskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>TrashedTask</maml:name> <maml:description> <maml:para>Specify the trashed Task to be returned using a task query. This only applies if the item is a task.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>TrashedWorkflow</maml:name> <maml:description> <maml:para>Specify the trashed Workflow to be returned using a workflow query. This only applies if the item is a workflow.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>TrashedBy</maml:name> <maml:description> <maml:para>Specify the trashed by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TrashQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TrashQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TrashQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the trash query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a trash properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TrashField[]</command:parameterValue> <dev:type> <maml:name>TrashField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TrashView</command:parameterValue> <dev:type> <maml:name>TrashView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">TrashOrderField</command:parameterValue> <dev:type> <maml:name>TrashOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>TrashedPerson</maml:name> <maml:description> <maml:para>Specify the trashed Person to be returned using a person query. This only applies if the item is a person.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>TrashedProblem</maml:name> <maml:description> <maml:para>Specify the trashed Problem to be returned using a problem query. This only applies if the item is a problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>TrashedProject</maml:name> <maml:description> <maml:para>Specify the trashed Project to be returned using a project query. This only applies if the item is a project.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>TrashedProjectTask</maml:name> <maml:description> <maml:para>Specify the trashed Project task to be returned using a project task query. This only applies if the item is a project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskQuery</command:parameterValue> <dev:type> <maml:name>ProjectTaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>TrashedRelease</maml:name> <maml:description> <maml:para>Specify the trashed Release to be returned using a release query. This only applies if the item is a release.</maml:para> </maml:description> <command:parameterValue required="false">ReleaseQuery</command:parameterValue> <dev:type> <maml:name>ReleaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>TrashedRequest</maml:name> <maml:description> <maml:para>Specify the trashed Request to be returned using a request query. This only applies if the item is a request.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>TrashedRisk</maml:name> <maml:description> <maml:para>Specify the trashed Risk to be returned using a risk query. This only applies if the item is a risk.</maml:para> </maml:description> <command:parameterValue required="false">RiskQuery</command:parameterValue> <dev:type> <maml:name>RiskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>TrashedTask</maml:name> <maml:description> <maml:para>Specify the trashed Task to be returned using a task query. This only applies if the item is a task.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>TrashedWorkflow</maml:name> <maml:description> <maml:para>Specify the trashed Workflow to be returned using a workflow query. This only applies if the item is a workflow.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>TrashedBy</maml:name> <maml:description> <maml:para>Specify the trashed by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<TrashQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<TrashQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<TrashQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TrashField[]</maml:name> </dev:type> <maml:description> <maml:para>The Trash field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TrashView</maml:name> </dev:type> <maml:description> <maml:para>The trash view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TrashOrderField</maml:name> </dev:type> <maml:description> <maml:para>The trash order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemQuery</maml:name> </dev:type> <maml:description> <maml:para>A problem query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectQuery</maml:name> </dev:type> <maml:description> <maml:para>A project query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A project task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReleaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A release query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskQuery</maml:name> </dev:type> <maml:description> <maml:para>A risk query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<TrashQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A trash query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TrashQuery</maml:name> </dev:type> <maml:description> <maml:para>A trash query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentTrashQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentTrashQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new trash query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentTrashQueryFilter cmdlet creates and configures a trash query filter object using the provided parameters. These filters can be used with the New-XurrentTrashQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentTrashQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TrashFilter</command:parameterValue> <dev:type> <maml:name>TrashFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">TrashFilter</command:parameterValue> <dev:type> <maml:name>TrashFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TrashFilter</maml:name> </dev:type> <maml:description> <maml:para>a trash filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<TrashQuery></maml:name> </dev:type> <maml:description> <maml:para>A trash query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentUiExtension</command:name> <command:verb>New</command:verb> <command:noun>XurrentUiExtension</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new user interface extension.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates an user interface extension using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentUiExtension</maml:name> <command:parameter required="true" position="0"> <maml:name>Category</maml:name> <maml:description> <maml:para>The type of record in which the UI extension can be selected.</maml:para> </maml:description> <command:parameterValue required="true">UiExtensionCategory</command:parameterValue> <dev:type> <maml:name>UiExtensionCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the UI extension.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Activate</maml:name> <maml:description> <maml:para>Set to true to promote the Prepared Version to the Active Version. If the was an Active Version, it will be Archived.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Css</maml:name> <maml:description> <maml:para>Sets the CSS stylesheet of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the UI extension.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the UI extension is inactive.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>FormDefinition</maml:name> <maml:description> <maml:para>Sets the Form Definition of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">JToken</command:parameterValue> <dev:type> <maml:name>JToken</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Html</maml:name> <maml:description> <maml:para>Sets the HTML code of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Javascript</maml:name> <maml:description> <maml:para>Sets the Javascript code of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Title</maml:name> <maml:description> <maml:para>The text that is to be displayed as the section header above the UI extension when the UI extension is presented within a form.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="14"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of user interface extension properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UiExtensionField[]</command:parameterValue> <dev:type> <maml:name>UiExtensionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Category</maml:name> <maml:description> <maml:para>The type of record in which the UI extension can be selected.</maml:para> </maml:description> <command:parameterValue required="true">UiExtensionCategory</command:parameterValue> <dev:type> <maml:name>UiExtensionCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the UI extension.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Activate</maml:name> <maml:description> <maml:para>Set to true to promote the Prepared Version to the Active Version. If the was an Active Version, it will be Archived.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Css</maml:name> <maml:description> <maml:para>Sets the CSS stylesheet of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the UI extension.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the UI extension is inactive.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>FormDefinition</maml:name> <maml:description> <maml:para>Sets the Form Definition of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">JToken</command:parameterValue> <dev:type> <maml:name>JToken</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Html</maml:name> <maml:description> <maml:para>Sets the HTML code of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Javascript</maml:name> <maml:description> <maml:para>Sets the Javascript code of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Title</maml:name> <maml:description> <maml:para>The text that is to be displayed as the section header above the UI extension when the UI extension is presented within a form.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="14"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of user interface extension properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UiExtensionField[]</command:parameterValue> <dev:type> <maml:name>UiExtensionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionCategory</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Newtonsoft.Json.Linq.JToken</maml:name> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionField[]</maml:name> </dev:type> <maml:description> <maml:para>The user interface extension field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>UiExtension</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentUiExtensionQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentUiExtensionQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an user interface extension query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentUiExtensionQuery cmdlet creates and configures an user interface extension query object using the provided parameters. These result can be used with the Invoke-XurrentUiExtensionQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentUiExtensionQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the UI extension query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an user interface extension properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UiExtensionField[]</command:parameterValue> <dev:type> <maml:name>UiExtensionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionView</command:parameterValue> <dev:type> <maml:name>UiExtensionView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionOrderField</command:parameterValue> <dev:type> <maml:name>UiExtensionOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ActiveVersion</maml:name> <maml:description> <maml:para>Specify the active version details to be returned using an user interface extension version query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionVersionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionVersionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Specify the created by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>UpdatedBy</maml:name> <maml:description> <maml:para>Specify the updated by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Versions</maml:name> <maml:description> <maml:para>Specify the versions details to be returned using an user interface extension version query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionVersionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionVersionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<UiExtensionQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<UiExtensionQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<UiExtensionQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the UI extension query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an user interface extension properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UiExtensionField[]</command:parameterValue> <dev:type> <maml:name>UiExtensionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionView</command:parameterValue> <dev:type> <maml:name>UiExtensionView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionOrderField</command:parameterValue> <dev:type> <maml:name>UiExtensionOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ActiveVersion</maml:name> <maml:description> <maml:para>Specify the active version details to be returned using an user interface extension version query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionVersionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionVersionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Specify the created by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>UpdatedBy</maml:name> <maml:description> <maml:para>Specify the updated by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Versions</maml:name> <maml:description> <maml:para>Specify the versions details to be returned using an user interface extension version query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionVersionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionVersionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<UiExtensionQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<UiExtensionQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<UiExtensionQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionField[]</maml:name> </dev:type> <maml:description> <maml:para>The UI extension field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionView</maml:name> </dev:type> <maml:description> <maml:para>The user interface extension view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionOrderField</maml:name> </dev:type> <maml:description> <maml:para>The user interface extension order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionVersionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension version query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<UiExtensionQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentUiExtensionQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentUiExtensionQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new user interface extension query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentUiExtensionQueryFilter cmdlet creates and configures an user interface extension query filter object using the provided parameters. These filters can be used with the New-XurrentUiExtensionQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentUiExtensionQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">UiExtensionFilter</command:parameterValue> <dev:type> <maml:name>UiExtensionFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">UiExtensionFilter</command:parameterValue> <dev:type> <maml:name>UiExtensionFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionFilter</maml:name> </dev:type> <maml:description> <maml:para>an user interface extension filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<UiExtensionQuery></maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentUiExtensionVersionQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentUiExtensionVersionQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new an user interface extension version query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentUiExtensionVersionQuery cmdlet creates and configures an user interface extension version query object using the provided parameters. These result can be used with the Invoke-XurrentUiExtensionVersionQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentUiExtensionVersionQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an user interface extension version properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UiExtensionVersionField[]</command:parameterValue> <dev:type> <maml:name>UiExtensionVersionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of an user interface extension version properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UiExtensionVersionField[]</command:parameterValue> <dev:type> <maml:name>UiExtensionVersionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionVersionField[]</maml:name> </dev:type> <maml:description> <maml:para>The UI extension version field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>UiExtensionVersionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension version query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWaitingForCustomerFollowUp</command:name> <command:verb>New</command:verb> <command:noun>XurrentWaitingForCustomerFollowUp</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new waiting for customer follow up.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a waiting for customer follow up using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWaitingForCustomerFollowUp</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the waiting for customer follow-up.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AutoComplete</maml:name> <maml:description> <maml:para>Auto-complete when the final waiting for customer notification is sent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the waiting for customer follow-up may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewWaitingForCustomerRules</maml:name> <maml:description> <maml:para>Rules of this waiting for customer follow-up.</maml:para> </maml:description> <command:parameterValue required="false">WaitingForCustomerRuleInput[]</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerRuleInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="7"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of waiting for customer follow up properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WaitingForCustomerFollowUpField[]</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerFollowUpField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the waiting for customer follow-up.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AutoComplete</maml:name> <maml:description> <maml:para>Auto-complete when the final waiting for customer notification is sent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the waiting for customer follow-up may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewWaitingForCustomerRules</maml:name> <maml:description> <maml:para>Rules of this waiting for customer follow-up.</maml:para> </maml:description> <command:parameterValue required="false">WaitingForCustomerRuleInput[]</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerRuleInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="7"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of waiting for customer follow up properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WaitingForCustomerFollowUpField[]</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerFollowUpField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WaitingForCustomerRuleInput[]</maml:name> </dev:type> <maml:description> <maml:para>A waiting for customer rule input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WaitingForCustomerFollowUpField[]</maml:name> </dev:type> <maml:description> <maml:para>The waiting for customer follow up field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WaitingForCustomerFollowUp</maml:name> </dev:type> <maml:description> <maml:para>A waiting for customer follow up object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWaitingForCustomerFollowUpQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentWaitingForCustomerFollowUpQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a waiting for customer follow up query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWaitingForCustomerFollowUpQuery cmdlet creates and configures a waiting for customer follow up query object using the provided parameters. These result can be used with the Invoke-XurrentWaitingForCustomerFollowUpQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWaitingForCustomerFollowUpQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the waiting for customer follow up query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a waiting for customer follow up properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WaitingForCustomerFollowUpField[]</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerFollowUpField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>WaitingForCustomerRules</maml:name> <maml:description> <maml:para>Specify the waiting for customer rules details to be returned using a waiting for customer rule query.</maml:para> </maml:description> <command:parameterValue required="false">WaitingForCustomerRuleQuery</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<WaitingForCustomerFollowUpQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<WaitingForCustomerFollowUpQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<WaitingForCustomerFollowUpQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the waiting for customer follow up query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a waiting for customer follow up properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WaitingForCustomerFollowUpField[]</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerFollowUpField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>WaitingForCustomerRules</maml:name> <maml:description> <maml:para>Specify the waiting for customer rules details to be returned using a waiting for customer rule query.</maml:para> </maml:description> <command:parameterValue required="false">WaitingForCustomerRuleQuery</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<WaitingForCustomerFollowUpQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<WaitingForCustomerFollowUpQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<WaitingForCustomerFollowUpQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WaitingForCustomerFollowUpField[]</maml:name> </dev:type> <maml:description> <maml:para>The Waiting for customer follow up field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WaitingForCustomerRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>A waiting for customer rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<WaitingForCustomerFollowUpQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A waiting for customer follow up query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WaitingForCustomerFollowUpQuery</maml:name> </dev:type> <maml:description> <maml:para>A waiting for customer follow up query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWaitingForCustomerFollowUpQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentWaitingForCustomerFollowUpQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new waiting for customer follow up query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWaitingForCustomerFollowUpQueryFilter cmdlet creates and configures a waiting for customer follow up query filter object using the provided parameters. These filters can be used with the New-XurrentWaitingForCustomerFollowUpQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWaitingForCustomerFollowUpQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">WaitingForCustomerFollowUpFilter</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerFollowUpFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">WaitingForCustomerFollowUpFilter</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerFollowUpFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WaitingForCustomerFollowUpFilter</maml:name> </dev:type> <maml:description> <maml:para>a waiting for customer follow up filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<WaitingForCustomerFollowUpQuery></maml:name> </dev:type> <maml:description> <maml:para>A waiting for customer follow up query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWaitingForCustomerRuleQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentWaitingForCustomerRuleQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a waiting for customer rule query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWaitingForCustomerRuleQuery cmdlet creates and configures a waiting for customer rule query object using the provided parameters. These result can be used with the Invoke-XurrentWaitingForCustomerRuleQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWaitingForCustomerRuleQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a waiting for customer rule properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WaitingForCustomerRuleField[]</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerRuleField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a waiting for customer rule properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WaitingForCustomerRuleField[]</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerRuleField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WaitingForCustomerRuleField[]</maml:name> </dev:type> <maml:description> <maml:para>The Waiting for customer rule field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WaitingForCustomerRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>A waiting for customer rule query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWatchQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentWatchQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a watch query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWatchQuery cmdlet creates and configures a watch query object using the provided parameters. These result can be used with the Invoke-XurrentWatchQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWatchQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a watch properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WatchField[]</command:parameterValue> <dev:type> <maml:name>WatchField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AddedBy</maml:name> <maml:description> <maml:para>Specify the added by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a watch properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WatchField[]</command:parameterValue> <dev:type> <maml:name>WatchField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AddedBy</maml:name> <maml:description> <maml:para>Specify the added by details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Person</maml:name> <maml:description> <maml:para>Specify the person details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WatchField[]</maml:name> </dev:type> <maml:description> <maml:para>The Watch field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WatchQuery</maml:name> </dev:type> <maml:description> <maml:para>A watch query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWebhook</command:name> <command:verb>New</command:verb> <command:noun>XurrentWebhook</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new webhook.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a webhook using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWebhook</maml:name> <command:parameter required="true" position="0"> <maml:name>Event</maml:name> <maml:description> <maml:para>Event that will trigger this webhook.</maml:para> </maml:description> <command:parameterValue required="true">WebhookEvent</command:parameterValue> <dev:type> <maml:name>WebhookEvent</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Publicly accessible URI that Xurrent can use to POST http messages to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the webhook's purpose.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the webhook will be triggered when the event occurs.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MailExceptionsTo</maml:name> <maml:description> <maml:para>Comma separated list of email addresses who will be informed when the webhook execution fails.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of this webhook. Defaults to the event name.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>WebhookPolicyId</maml:name> <maml:description> <maml:para>The webhook policy to use for cryptographic signing of the messages.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of webhook properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookField[]</command:parameterValue> <dev:type> <maml:name>WebhookField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Event</maml:name> <maml:description> <maml:para>Event that will trigger this webhook.</maml:para> </maml:description> <command:parameterValue required="true">WebhookEvent</command:parameterValue> <dev:type> <maml:name>WebhookEvent</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Publicly accessible URI that Xurrent can use to POST http messages to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the webhook's purpose.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the webhook will be triggered when the event occurs.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MailExceptionsTo</maml:name> <maml:description> <maml:para>Comma separated list of email addresses who will be informed when the webhook execution fails.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of this webhook. Defaults to the event name.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>WebhookPolicyId</maml:name> <maml:description> <maml:para>The webhook policy to use for cryptographic signing of the messages.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of webhook properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookField[]</command:parameterValue> <dev:type> <maml:name>WebhookField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookEvent</maml:name> </dev:type> <maml:description> <maml:para>A webhook event object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookField[]</maml:name> </dev:type> <maml:description> <maml:para>The webhook field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Webhook</maml:name> </dev:type> <maml:description> <maml:para>A webhook object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWebhookPolicy</command:name> <command:verb>New</command:verb> <command:noun>XurrentWebhookPolicy</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new webhook policy.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a webhook policy using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWebhookPolicy</maml:name> <command:parameter required="true" position="0"> <maml:name>JwtAlg</maml:name> <maml:description> <maml:para>The algorithm to use for cryptographic signing of webhook messages.</maml:para> </maml:description> <command:parameterValue required="true">WebhookPolicyJwtAlg</command:parameterValue> <dev:type> <maml:name>WebhookPolicyJwtAlg</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the webhook policy will be applied.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>JwtAudience</maml:name> <maml:description> <maml:para>The audience claim identifies the recipients that the encrypted message is intended for.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>JwtClaimExpiresIn</maml:name> <maml:description> <maml:para>The number of minutes within which the claim expires.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of webhook policy properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookPolicyCreateResponseField[]</command:parameterValue> <dev:type> <maml:name>WebhookPolicyCreateResponseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>JwtAlg</maml:name> <maml:description> <maml:para>The algorithm to use for cryptographic signing of webhook messages.</maml:para> </maml:description> <command:parameterValue required="true">WebhookPolicyJwtAlg</command:parameterValue> <dev:type> <maml:name>WebhookPolicyJwtAlg</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the webhook policy will be applied.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>JwtAudience</maml:name> <maml:description> <maml:para>The audience claim identifies the recipients that the encrypted message is intended for.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>JwtClaimExpiresIn</maml:name> <maml:description> <maml:para>The number of minutes within which the claim expires.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of webhook policy properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookPolicyCreateResponseField[]</command:parameterValue> <dev:type> <maml:name>WebhookPolicyCreateResponseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookPolicyJwtAlg</maml:name> </dev:type> <maml:description> <maml:para>A webhook policy JSON web token alg object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookPolicyCreateResponseField[]</maml:name> </dev:type> <maml:description> <maml:para>The webhook policy create response field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WebhookPolicy</maml:name> </dev:type> <maml:description> <maml:para>A webhook policy create response object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWebhookPolicyCreateResponseQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentWebhookPolicyCreateResponseQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a webhook policy create response query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWebhookPolicyCreateResponseQuery cmdlet creates and configures a webhook policy create response query object using the provided parameters. These result can be used with the Invoke-XurrentWebhookPolicyCreateResponseQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWebhookPolicyCreateResponseQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a webhook policy create response properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookPolicyCreateResponseField[]</command:parameterValue> <dev:type> <maml:name>WebhookPolicyCreateResponseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a webhook policy create response properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookPolicyCreateResponseField[]</command:parameterValue> <dev:type> <maml:name>WebhookPolicyCreateResponseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookPolicyCreateResponseField[]</maml:name> </dev:type> <maml:description> <maml:para>The Webhook policy create response field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WebhookPolicyCreateResponseQuery</maml:name> </dev:type> <maml:description> <maml:para>A webhook policy create response query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWebhookPolicyQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentWebhookPolicyQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a webhook policy query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWebhookPolicyQuery cmdlet creates and configures a webhook policy query object using the provided parameters. These result can be used with the Invoke-XurrentWebhookPolicyQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWebhookPolicyQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the webhook policy query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a webhook policy properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookPolicyField[]</command:parameterValue> <dev:type> <maml:name>WebhookPolicyField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<WebhookPolicyQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<WebhookPolicyQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<WebhookPolicyQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the webhook policy query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a webhook policy properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookPolicyField[]</command:parameterValue> <dev:type> <maml:name>WebhookPolicyField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<WebhookPolicyQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<WebhookPolicyQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<WebhookPolicyQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookPolicyField[]</maml:name> </dev:type> <maml:description> <maml:para>The Webhook policy field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<WebhookPolicyQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A webhook policy query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WebhookPolicyQuery</maml:name> </dev:type> <maml:description> <maml:para>A webhook policy query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWebhookPolicyQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentWebhookPolicyQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new webhook policy query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWebhookPolicyQueryFilter cmdlet creates and configures a webhook policy query filter object using the provided parameters. These filters can be used with the New-XurrentWebhookPolicyQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWebhookPolicyQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">WebhookPolicyFilter</command:parameterValue> <dev:type> <maml:name>WebhookPolicyFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">WebhookPolicyFilter</command:parameterValue> <dev:type> <maml:name>WebhookPolicyFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookPolicyFilter</maml:name> </dev:type> <maml:description> <maml:para>a webhook policy filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<WebhookPolicyQuery></maml:name> </dev:type> <maml:description> <maml:para>A webhook policy query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWebhookQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentWebhookQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a webhook query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWebhookQuery cmdlet creates and configures a webhook query object using the provided parameters. These result can be used with the Invoke-XurrentWebhookQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWebhookQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the webhook query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a webhook properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookField[]</command:parameterValue> <dev:type> <maml:name>WebhookField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>WebhookPolicy</maml:name> <maml:description> <maml:para>Specify the webhook policy details to be returned using a webhook policy query.</maml:para> </maml:description> <command:parameterValue required="false">WebhookPolicyQuery</command:parameterValue> <dev:type> <maml:name>WebhookPolicyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<WebhookQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<WebhookQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<WebhookQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the webhook query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a webhook properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookField[]</command:parameterValue> <dev:type> <maml:name>WebhookField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Specify the description attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>WebhookPolicy</maml:name> <maml:description> <maml:para>Specify the webhook policy details to be returned using a webhook policy query.</maml:para> </maml:description> <command:parameterValue required="false">WebhookPolicyQuery</command:parameterValue> <dev:type> <maml:name>WebhookPolicyQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<WebhookQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<WebhookQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<WebhookQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookField[]</maml:name> </dev:type> <maml:description> <maml:para>The Webhook field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookPolicyQuery</maml:name> </dev:type> <maml:description> <maml:para>A webhook policy query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<WebhookQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A webhook query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WebhookQuery</maml:name> </dev:type> <maml:description> <maml:para>A webhook query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWebhookQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentWebhookQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new webhook query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWebhookQueryFilter cmdlet creates and configures a webhook query filter object using the provided parameters. These filters can be used with the New-XurrentWebhookQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWebhookQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">WebhookFilter</command:parameterValue> <dev:type> <maml:name>WebhookFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">WebhookFilter</command:parameterValue> <dev:type> <maml:name>WebhookFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookFilter</maml:name> </dev:type> <maml:description> <maml:para>a webhook filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<WebhookQuery></maml:name> </dev:type> <maml:description> <maml:para>A webhook query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWorkflow</command:name> <command:verb>New</command:verb> <command:noun>XurrentWorkflow</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new workflow.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a workflow using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWorkflow</maml:name> <command:parameter required="false" position="0"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the workflow.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowCategory</command:parameterValue> <dev:type> <maml:name>WorkflowCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>Used to select the appropriate completion reason for the workflow when it has been completed. It is automatically set to "Complete" when all tasks related to the workflow have reached the status "Completed", "Approved" or "Canceled".</maml:para> </maml:description> <command:parameterValue required="false">WorkflowCompletionReason</command:parameterValue> <dev:type> <maml:name>WorkflowCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Justification</maml:name> <maml:description> <maml:para>The reason why the change was requested.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowJustification</command:parameterValue> <dev:type> <maml:name>WorkflowJustification</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Who is responsible for coordinating the implementation of the workflow. If a manager is not specified for a new workflow, the API user is selected in the Manager field by default.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Note</maml:name> <maml:description> <maml:para>High-level description of the result that should be accomplished by the implementation of the workflow. It is also used to add any information that could prove useful for anyone affected by the workflow, including the people whose approval is needed and the specialists who are helping to implement it.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ProblemIds</maml:name> <maml:description> <maml:para>Identifiers of all problems linked of this workflow.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>Linked project</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ReleaseId</maml:name> <maml:description> <maml:para>The release that the workflow is a part of.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RequestIds</maml:name> <maml:description> <maml:para>Identifiers of all requests linked to this workflow.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>The service that will directly be affected by the workflow implementation, or in case of an emergency change, the service that was directly affected by the workflow implementation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The date and time at which the Status field of the first tasks of the workflow will automatically be set to "Assigned".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Status</maml:name> <maml:description> <maml:para>Automatically set based on the status of the workflow's tasks.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowStatus</command:parameterValue> <dev:type> <maml:name>WorkflowStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>The workflow template that was used to register the workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>WorkflowType</maml:name> <maml:description> <maml:para>Used to indicate whether the workflow needs to be implemented following the procedure steps for application changes or for infrastructure changes.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="20"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of workflow properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowField[]</command:parameterValue> <dev:type> <maml:name>WorkflowField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the workflow.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowCategory</command:parameterValue> <dev:type> <maml:name>WorkflowCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>Used to select the appropriate completion reason for the workflow when it has been completed. It is automatically set to "Complete" when all tasks related to the workflow have reached the status "Completed", "Approved" or "Canceled".</maml:para> </maml:description> <command:parameterValue required="false">WorkflowCompletionReason</command:parameterValue> <dev:type> <maml:name>WorkflowCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Justification</maml:name> <maml:description> <maml:para>The reason why the change was requested.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowJustification</command:parameterValue> <dev:type> <maml:name>WorkflowJustification</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Who is responsible for coordinating the implementation of the workflow. If a manager is not specified for a new workflow, the API user is selected in the Manager field by default.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Note</maml:name> <maml:description> <maml:para>High-level description of the result that should be accomplished by the implementation of the workflow. It is also used to add any information that could prove useful for anyone affected by the workflow, including the people whose approval is needed and the specialists who are helping to implement it.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ProblemIds</maml:name> <maml:description> <maml:para>Identifiers of all problems linked of this workflow.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>Linked project</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ReleaseId</maml:name> <maml:description> <maml:para>The release that the workflow is a part of.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RequestIds</maml:name> <maml:description> <maml:para>Identifiers of all requests linked to this workflow.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>The service that will directly be affected by the workflow implementation, or in case of an emergency change, the service that was directly affected by the workflow implementation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The date and time at which the Status field of the first tasks of the workflow will automatically be set to "Assigned".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Status</maml:name> <maml:description> <maml:para>Automatically set based on the status of the workflow's tasks.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowStatus</command:parameterValue> <dev:type> <maml:name>WorkflowStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>The workflow template that was used to register the workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>WorkflowType</maml:name> <maml:description> <maml:para>Used to indicate whether the workflow needs to be implemented following the procedure steps for application changes or for infrastructure changes.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="20"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of workflow properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowField[]</command:parameterValue> <dev:type> <maml:name>WorkflowField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowCategory</maml:name> </dev:type> <maml:description> <maml:para>A workflow category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowCompletionReason</maml:name> </dev:type> <maml:description> <maml:para>A workflow completion reason object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowJustification</maml:name> </dev:type> <maml:description> <maml:para>A workflow justification object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowStatus</maml:name> </dev:type> <maml:description> <maml:para>A workflow status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowField[]</maml:name> </dev:type> <maml:description> <maml:para>The workflow field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Workflow</maml:name> </dev:type> <maml:description> <maml:para>A workflow object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWorkflowPhaseQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentWorkflowPhaseQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a workflow phase query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWorkflowPhaseQuery cmdlet creates and configures a workflow phase query object using the provided parameters. These result can be used with the Invoke-XurrentWorkflowPhaseQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWorkflowPhaseQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a workflow phase properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowPhaseField[]</command:parameterValue> <dev:type> <maml:name>WorkflowPhaseField[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a workflow phase properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowPhaseField[]</command:parameterValue> <dev:type> <maml:name>WorkflowPhaseField[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowPhaseField[]</maml:name> </dev:type> <maml:description> <maml:para>The Workflow phase field enumerator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WorkflowPhaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow phase query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWorkflowQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentWorkflowQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a workflow query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWorkflowQuery cmdlet creates and configures a workflow query object using the provided parameters. These result can be used with the Invoke-XurrentWorkflowQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWorkflowQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the workflow query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a workflow properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowField[]</command:parameterValue> <dev:type> <maml:name>WorkflowField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowView</command:parameterValue> <dev:type> <maml:name>WorkflowView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowOrderField</command:parameterValue> <dev:type> <maml:name>WorkflowOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Invoices</maml:name> <maml:description> <maml:para>Specify the invoices details to be returned using an invoice query.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Phases</maml:name> <maml:description> <maml:para>Specify the phases details to be returned using a workflow phase query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowPhaseQuery</command:parameterValue> <dev:type> <maml:name>WorkflowPhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Problems</maml:name> <maml:description> <maml:para>Specify the problems details to be returned using a problem query.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specify the project details to be returned using a project query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Release</maml:name> <maml:description> <maml:para>Specify the release details to be returned using a release query.</maml:para> </maml:description> <command:parameterValue required="false">ReleaseQuery</command:parameterValue> <dev:type> <maml:name>ReleaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Requests</maml:name> <maml:description> <maml:para>Specify the requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Tasks</maml:name> <maml:description> <maml:para>Specify the tasks details to be returned using a task query.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specify the template details to be returned using a workflow template query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<WorkflowQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<WorkflowQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<WorkflowQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the workflow query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a workflow properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowField[]</command:parameterValue> <dev:type> <maml:name>WorkflowField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowView</command:parameterValue> <dev:type> <maml:name>WorkflowView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowOrderField</command:parameterValue> <dev:type> <maml:name>WorkflowOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Specify the custom fields details to be returned using a custom field query.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldQuery</command:parameterValue> <dev:type> <maml:name>CustomFieldQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>Specify the custom fields attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Invoices</maml:name> <maml:description> <maml:para>Specify the invoices details to be returned using an invoice query.</maml:para> </maml:description> <command:parameterValue required="false">InvoiceQuery</command:parameterValue> <dev:type> <maml:name>InvoiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Manager</maml:name> <maml:description> <maml:para>Specify the manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Specify the notes details to be returned using a note query.</maml:para> </maml:description> <command:parameterValue required="false">NoteQuery</command:parameterValue> <dev:type> <maml:name>NoteQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Phases</maml:name> <maml:description> <maml:para>Specify the phases details to be returned using a workflow phase query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowPhaseQuery</command:parameterValue> <dev:type> <maml:name>WorkflowPhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Problems</maml:name> <maml:description> <maml:para>Specify the problems details to be returned using a problem query.</maml:para> </maml:description> <command:parameterValue required="false">ProblemQuery</command:parameterValue> <dev:type> <maml:name>ProblemQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specify the project details to be returned using a project query.</maml:para> </maml:description> <command:parameterValue required="false">ProjectQuery</command:parameterValue> <dev:type> <maml:name>ProjectQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Release</maml:name> <maml:description> <maml:para>Specify the release details to be returned using a release query.</maml:para> </maml:description> <command:parameterValue required="false">ReleaseQuery</command:parameterValue> <dev:type> <maml:name>ReleaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Requests</maml:name> <maml:description> <maml:para>Specify the requests details to be returned using a request query.</maml:para> </maml:description> <command:parameterValue required="false">RequestQuery</command:parameterValue> <dev:type> <maml:name>RequestQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Tasks</maml:name> <maml:description> <maml:para>Specify the tasks details to be returned using a task query.</maml:para> </maml:description> <command:parameterValue required="false">TaskQuery</command:parameterValue> <dev:type> <maml:name>TaskQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specify the template details to be returned using a workflow template query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<WorkflowQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<WorkflowQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<WorkflowQuery>[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>CustomFilters</maml:name> <maml:description> <maml:para>An array of additional custom filters to apply. These filters are of type CustomFilter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomFilter[]</command:parameterValue> <dev:type> <maml:name>CustomFilter[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowField[]</maml:name> </dev:type> <maml:description> <maml:para>The Workflow field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowView</maml:name> </dev:type> <maml:description> <maml:para>The workflow view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowOrderField</maml:name> </dev:type> <maml:description> <maml:para>The workflow order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldQuery</maml:name> </dev:type> <maml:description> <maml:para>A custom field query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InvoiceQuery</maml:name> </dev:type> <maml:description> <maml:para>An invoice query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.NoteQuery</maml:name> </dev:type> <maml:description> <maml:para>A note query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowPhaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow phase query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemQuery</maml:name> </dev:type> <maml:description> <maml:para>A problem query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectQuery</maml:name> </dev:type> <maml:description> <maml:para>A project query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReleaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A release query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestQuery</maml:name> </dev:type> <maml:description> <maml:para>A request query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskQuery</maml:name> </dev:type> <maml:description> <maml:para>A task query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<WorkflowQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A workflow query filter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFilter[]</maml:name> </dev:type> <maml:description> <maml:para>A custom filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWorkflowQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentWorkflowQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new workflow query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWorkflowQueryFilter cmdlet creates and configures a workflow query filter object using the provided parameters. These filters can be used with the New-XurrentWorkflowQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWorkflowQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowFilter</command:parameterValue> <dev:type> <maml:name>WorkflowFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowFilter</command:parameterValue> <dev:type> <maml:name>WorkflowFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowFilter</maml:name> </dev:type> <maml:description> <maml:para>a workflow filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<WorkflowQuery></maml:name> </dev:type> <maml:description> <maml:para>A workflow query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWorkflowTaskTemplateRelationQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentWorkflowTaskTemplateRelationQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a workflow task template relation query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWorkflowTaskTemplateRelationQuery cmdlet creates and configures a workflow task template relation query object using the provided parameters. These result can be used with the Invoke-XurrentWorkflowTaskTemplateRelationQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWorkflowTaskTemplateRelationQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a workflow task template relation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTaskTemplateRelationField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTaskTemplateRelationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>FailureTaskTemplate</maml:name> <maml:description> <maml:para>Specify the failure task template details to be returned using a task template query.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>TaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Phase</maml:name> <maml:description> <maml:para>Specify the phase details to be returned using a workflow template phase query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplatePhaseQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplatePhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>TaskTemplate</maml:name> <maml:description> <maml:para>Specify the task template details to be returned using a task template query.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>TaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>WorkflowTemplate</maml:name> <maml:description> <maml:para>Specify the workflow template details to be returned using a workflow template query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a workflow task template relation properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTaskTemplateRelationField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTaskTemplateRelationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>FailureTaskTemplate</maml:name> <maml:description> <maml:para>Specify the failure task template details to be returned using a task template query.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>TaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Phase</maml:name> <maml:description> <maml:para>Specify the phase details to be returned using a workflow template phase query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplatePhaseQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplatePhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>TaskTemplate</maml:name> <maml:description> <maml:para>Specify the task template details to be returned using a task template query.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateQuery</command:parameterValue> <dev:type> <maml:name>TaskTemplateQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>WorkflowTemplate</maml:name> <maml:description> <maml:para>Specify the workflow template details to be returned using a workflow template query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTaskTemplateRelationField[]</maml:name> </dev:type> <maml:description> <maml:para>The Workflow task template relation field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A task template query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplatePhaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow template phase query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow template query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WorkflowTaskTemplateRelationQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow task template relation query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWorkflowTemplate</command:name> <command:verb>New</command:verb> <command:noun>XurrentWorkflowTemplate</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new workflow template.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a workflow template using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWorkflowTemplate</maml:name> <command:parameter required="true" position="0"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Short description that needs to be copied to the Subject field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowCategory</command:parameterValue> <dev:type> <maml:name>WorkflowCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the workflow template may not be used to help register new workflows.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>The information that needs to be shown when a new workflow is being created based on the template. This field typically contains instructions about how to register the workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Justification</maml:name> <maml:description> <maml:para>The justification that needs to be selected in the Justification field of a new workflow when it is being created based on the template. This field is required when there are request templates linked to the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowJustification</command:parameterValue> <dev:type> <maml:name>WorkflowJustification</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>NewTaskTemplateRelations</maml:name> <maml:description> <maml:para>Task template relations of the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateTaskTemplateInput[]</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateTaskTemplateInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceInput</command:parameterValue> <dev:type> <maml:name>RecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>The service that should be selected in the Service field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>The person who will be responsible for coordinating the workflows that will be generated automatically in accordance with the recurrence schedule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>WorkflowTypeId</maml:name> <maml:description> <maml:para>The type that needs to be selected in the Type field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="15"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of workflow template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTemplateField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Short description that needs to be copied to the Subject field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowCategory</command:parameterValue> <dev:type> <maml:name>WorkflowCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the workflow template may not be used to help register new workflows.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>The information that needs to be shown when a new workflow is being created based on the template. This field typically contains instructions about how to register the workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Justification</maml:name> <maml:description> <maml:para>The justification that needs to be selected in the Justification field of a new workflow when it is being created based on the template. This field is required when there are request templates linked to the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowJustification</command:parameterValue> <dev:type> <maml:name>WorkflowJustification</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>NewTaskTemplateRelations</maml:name> <maml:description> <maml:para>Task template relations of the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateTaskTemplateInput[]</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateTaskTemplateInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceInput</command:parameterValue> <dev:type> <maml:name>RecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>The service that should be selected in the Service field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>The person who will be responsible for coordinating the workflows that will be generated automatically in accordance with the recurrence schedule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>WorkflowTypeId</maml:name> <maml:description> <maml:para>The type that needs to be selected in the Type field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="15"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of workflow template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTemplateField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowCategory</maml:name> </dev:type> <maml:description> <maml:para>A workflow category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowJustification</maml:name> </dev:type> <maml:description> <maml:para>A workflow justification object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateTaskTemplateInput[]</maml:name> </dev:type> <maml:description> <maml:para>A workflow template task template input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecurrenceInput</maml:name> </dev:type> <maml:description> <maml:para>A recurrence input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The workflow template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WorkflowTemplate</maml:name> </dev:type> <maml:description> <maml:para>A workflow template object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWorkflowTemplatePhaseQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentWorkflowTemplatePhaseQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a workflow template phase query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWorkflowTemplatePhaseQuery cmdlet creates and configures a workflow template phase query object using the provided parameters. These result can be used with the Invoke-XurrentWorkflowTemplatePhaseQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWorkflowTemplatePhaseQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a workflow template phase properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTemplatePhaseField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTemplatePhaseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a workflow template phase properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTemplatePhaseField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTemplatePhaseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplatePhaseField[]</maml:name> </dev:type> <maml:description> <maml:para>The Workflow template phase field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WorkflowTemplatePhaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow template phase query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWorkflowTemplateQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentWorkflowTemplateQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a workflow template query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWorkflowTemplateQuery cmdlet creates and configures a workflow template query object using the provided parameters. These result can be used with the Invoke-XurrentWorkflowTemplateQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWorkflowTemplateQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the workflow template query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a workflow template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTemplateField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateView</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateOrderField</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>Specify the note attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Phases</maml:name> <maml:description> <maml:para>Specify the phases details to be returned using a workflow template phase query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplatePhaseQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplatePhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Specify the recurrence details to be returned using a recurrence query.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceQuery</command:parameterValue> <dev:type> <maml:name>RecurrenceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>TaskTemplateRelations</maml:name> <maml:description> <maml:para>Specify the task template relations details to be returned using a workflow task template relation query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTaskTemplateRelationQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTaskTemplateRelationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>WorkflowManager</maml:name> <maml:description> <maml:para>Specify the workflow manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Workflows</maml:name> <maml:description> <maml:para>Specify the workflows details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>WorkflowType</maml:name> <maml:description> <maml:para>Specify the workflow type details to be returned using a workflow type query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTypeQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTypeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<WorkflowTemplateQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<WorkflowTemplateQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<WorkflowTemplateQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the workflow template query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a workflow template properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTemplateField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateView</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateOrderField</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AutomationRules</maml:name> <maml:description> <maml:para>Specify the automation rules details to be returned using an automation rule query.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleQuery</command:parameterValue> <dev:type> <maml:name>AutomationRuleQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>Specify the instructions attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>Specify the note attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Phases</maml:name> <maml:description> <maml:para>Specify the phases details to be returned using a workflow template phase query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplatePhaseQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTemplatePhaseQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Specify the recurrence details to be returned using a recurrence query.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceQuery</command:parameterValue> <dev:type> <maml:name>RecurrenceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specify the service details to be returned using a service query.</maml:para> </maml:description> <command:parameterValue required="false">ServiceQuery</command:parameterValue> <dev:type> <maml:name>ServiceQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>TaskTemplateRelations</maml:name> <maml:description> <maml:para>Specify the task template relations details to be returned using a workflow task template relation query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTaskTemplateRelationQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTaskTemplateRelationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>UiExtension</maml:name> <maml:description> <maml:para>Specify the UI extension details to be returned using an user interface extension query.</maml:para> </maml:description> <command:parameterValue required="false">UiExtensionQuery</command:parameterValue> <dev:type> <maml:name>UiExtensionQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>WorkflowManager</maml:name> <maml:description> <maml:para>Specify the workflow manager details to be returned using a person query.</maml:para> </maml:description> <command:parameterValue required="false">PersonQuery</command:parameterValue> <dev:type> <maml:name>PersonQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Workflows</maml:name> <maml:description> <maml:para>Specify the workflows details to be returned using a workflow query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowQuery</command:parameterValue> <dev:type> <maml:name>WorkflowQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>WorkflowType</maml:name> <maml:description> <maml:para>Specify the workflow type details to be returned using a workflow type query.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTypeQuery</command:parameterValue> <dev:type> <maml:name>WorkflowTypeQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<WorkflowTemplateQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<WorkflowTemplateQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<WorkflowTemplateQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The Workflow template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateView</maml:name> </dev:type> <maml:description> <maml:para>The workflow template view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateOrderField</maml:name> </dev:type> <maml:description> <maml:para>The workflow template order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleQuery</maml:name> </dev:type> <maml:description> <maml:para>An automation rule query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplatePhaseQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow template phase query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecurrenceQuery</maml:name> </dev:type> <maml:description> <maml:para>A recurrence query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceQuery</maml:name> </dev:type> <maml:description> <maml:para>A service query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTaskTemplateRelationQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow task template relation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionQuery</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonQuery</maml:name> </dev:type> <maml:description> <maml:para>A person query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTypeQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow type query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<WorkflowTemplateQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A workflow template query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WorkflowTemplateQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow template query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWorkflowTemplateQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentWorkflowTemplateQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new workflow template query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWorkflowTemplateQueryFilter cmdlet creates and configures a workflow template query filter object using the provided parameters. These filters can be used with the New-XurrentWorkflowTemplateQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWorkflowTemplateQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowTemplateFilter</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowTemplateFilter</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateFilter</maml:name> </dev:type> <maml:description> <maml:para>a workflow template filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<WorkflowTemplateQuery></maml:name> </dev:type> <maml:description> <maml:para>A workflow template query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWorkflowType</command:name> <command:verb>New</command:verb> <command:noun>XurrentWorkflowType</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new workflow type.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Creates a workflow type using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWorkflowType</maml:name> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the workflow type. Ideally the name of a workflow type consists of a single word, such as "Large".</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Very short description of the workflow type, for example "More than 200 workdays or $200K".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the workflow type may not be related to any more workflows.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the workflow type that might prove useful, especially for workflow managers when they need to decide which workflow type to select for a workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the workflow type takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of workflow type properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTypeField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTypeField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the workflow type. Ideally the name of a workflow type consists of a single word, such as "Large".</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Very short description of the workflow type, for example "More than 200 workdays or $200K".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the workflow type may not be related to any more workflows.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the workflow type that might prove useful, especially for workflow managers when they need to decide which workflow type to select for a workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the workflow type takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of workflow type properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTypeField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTypeField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the create mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTypeField[]</maml:name> </dev:type> <maml:description> <maml:para>The workflow type field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WorkflowType</maml:name> </dev:type> <maml:description> <maml:para>A workflow type object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWorkflowTypeQuery</command:name> <command:verb>New</command:verb> <command:noun>XurrentWorkflowTypeQuery</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new a workflow type query.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWorkflowTypeQuery cmdlet creates and configures a workflow type query object using the provided parameters. These result can be used with the Invoke-XurrentWorkflowTypeQuery cmdlet's query parameter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWorkflowTypeQueryFilter</maml:name> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the workflow type query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a workflow type properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTypeField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTypeField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<WorkflowTypeQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<WorkflowTypeQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<WorkflowTypeQuery>[]</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies an ID to further filter the workflow type query, rendering other filters redundant by directly referencing a specific object.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ItemsPerRequest</maml:name> <maml:description> <maml:para>The request specifies a maximum number of items per request. The allowed range for the number of items is between 1 and 100, inclusive.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of a workflow type properties to include in the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTypeField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTypeField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>View</maml:name> <maml:description> <maml:para>Specifies the view of the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultView</command:parameterValue> <dev:type> <maml:name>DefaultView</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the query results. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">DefaultOrderField</command:parameterValue> <dev:type> <maml:name>DefaultOrderField</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sorting order for the order by field. This setting is applicable only to the primary query and will be disregarded for nested queries.</maml:para> </maml:description> <command:parameterValue required="false">OrderBySortOrder</command:parameterValue> <dev:type> <maml:name>OrderBySortOrder</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify the account details to be returned using an account query.</maml:para> </maml:description> <command:parameterValue required="false">AccountQuery</command:parameterValue> <dev:type> <maml:name>AccountQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>Specify the information attachments details to be returned using an attachment query.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentQuery</command:parameterValue> <dev:type> <maml:name>AttachmentQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Translations</maml:name> <maml:description> <maml:para>Specify the translations details to be returned using a translation query.</maml:para> </maml:description> <command:parameterValue required="false">TranslationQuery</command:parameterValue> <dev:type> <maml:name>TranslationQuery</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Filters</maml:name> <maml:description> <maml:para>An array of additional filters to apply. These filters are of type QueryFilter<WorkflowTypeQueryQuery>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">QueryFilter<WorkflowTypeQuery>[]</command:parameterValue> <dev:type> <maml:name>QueryFilter<WorkflowTypeQuery>[]</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTypeField[]</maml:name> </dev:type> <maml:description> <maml:para>The Workflow type field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultView</maml:name> </dev:type> <maml:description> <maml:para>The default view enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.DefaultOrderField</maml:name> </dev:type> <maml:description> <maml:para>The default order field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrderBySortOrder</maml:name> </dev:type> <maml:description> <maml:para>The sort order enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AccountQuery</maml:name> </dev:type> <maml:description> <maml:para>An account query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentQuery</maml:name> </dev:type> <maml:description> <maml:para>An attachment query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationQuery</maml:name> </dev:type> <maml:description> <maml:para>A translation query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.QueryFilter<WorkflowTypeQuery>[]</maml:name> </dev:type> <maml:description> <maml:para>A workflow type query filter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WorkflowTypeQuery</maml:name> </dev:type> <maml:description> <maml:para>A workflow type query.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-XurrentWorkflowTypeQueryFilter</command:name> <command:verb>New</command:verb> <command:noun>XurrentWorkflowTypeQueryFilter</command:noun> <command:description> <maml:para>A PowerShell cmdlet for creating a new workflow type query filter.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The New-XurrentWorkflowTypeQueryFilter cmdlet creates and configures a workflow type query filter object using the provided parameters. These filters can be used with the New-XurrentWorkflowTypeQuery cmdlet's filters parameter.</maml:para> <maml:para>Note: Only one of the filters (TextValues, DateTimeValues, or BooleanValue) can be used at a time. You cannot combine these filters; choose the appropriate filter type based on the property you want to filter.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>New-XurrentWorkflowTypeQueryFilter</maml:name> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowTypeFilter</command:parameterValue> <dev:type> <maml:name>WorkflowTypeFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowTypeFilter</command:parameterValue> <dev:type> <maml:name>WorkflowTypeFilter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>The operator used for filtering.</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>FilterOperator</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TextValues</maml:name> <maml:description> <maml:para>The text values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DateTimeValues</maml:name> <maml:description> <maml:para>The date/time values to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>BooleanValue</maml:name> <maml:description> <maml:para>The boolean value to filter the property by.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTypeFilter</maml:name> </dev:type> <maml:description> <maml:para>a workflow type filter enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FilterOperator</maml:name> </dev:type> <maml:description> <maml:para>A filter operator enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryFilter<WorkflowTypeQuery></maml:name> </dev:type> <maml:description> <maml:para>A workflow type query filter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-XurrentAppOfferingAutomationRule</command:name> <command:verb>Remove</command:verb> <command:noun>XurrentAppOfferingAutomationRule</command:noun> <command:description> <maml:para>A PowerShell cmdlet for deleting an app offering automation rule.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Delete an app offering automation rule Susing the identifier.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-XurrentAppOfferingAutomationRule</maml:name> <command:parameter required="true" position="0"> <maml:name>ClientMutationID</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the delete mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ClientMutationID</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the delete mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <maml:description> <maml:para>True in case of success; otherwise false.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-XurrentNoteReaction</command:name> <command:verb>Remove</command:verb> <command:noun>XurrentNoteReaction</command:noun> <command:description> <maml:para>A PowerShell cmdlet for deleting a note reaction.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Delete a note reaction Susing the identifier.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-XurrentNoteReaction</maml:name> <command:parameter required="true" position="0"> <maml:name>ClientMutationID</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the delete mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ClientMutationID</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the delete mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <maml:description> <maml:para>True in case of success; otherwise false.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-XurrentWebhook</command:name> <command:verb>Remove</command:verb> <command:noun>XurrentWebhook</command:noun> <command:description> <maml:para>A PowerShell cmdlet for deleting a webhook.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Delete a webhook Susing the identifier.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-XurrentWebhook</maml:name> <command:parameter required="true" position="0"> <maml:name>ClientMutationID</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the delete mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ClientMutationID</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the delete mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <maml:description> <maml:para>True in case of success; otherwise false.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-XurrentWebhookPolicy</command:name> <command:verb>Remove</command:verb> <command:noun>XurrentWebhookPolicy</command:noun> <command:description> <maml:para>A PowerShell cmdlet for deleting a webhook policy.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Delete a webhook policy Susing the identifier.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-XurrentWebhookPolicy</maml:name> <command:parameter required="true" position="0"> <maml:name>ClientMutationID</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the delete mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ClientMutationID</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the delete mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <maml:description> <maml:para>True in case of success; otherwise false.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-XurrentDataExport</command:name> <command:verb>Save</command:verb> <command:noun>XurrentDataExport</command:noun> <command:description> <maml:para>A PowerShell cmdlet to wait for the data export process to complete, download the file, and save it to a specified path.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Save-XurrentDataExport cmdlet polls the export status at specified intervals, downloads the file once the export is complete, and saves it to the provided file path.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Save-XurrentDataExport</maml:name> <command:parameter required="true" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>The export token.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PollingInterval</maml:name> <maml:description> <maml:para>The interval in seconds to wait between status checks.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path where the exported file will be saved.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The maximum time in seconds to wait for the export to complete.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Client</maml:name> <maml:description> <maml:para>The Xurrent PowerShell client instance.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>The export token.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PollingInterval</maml:name> <maml:description> <maml:para>The interval in seconds to wait between status checks.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path where the exported file will be saved.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The maximum time in seconds to wait for the export to complete.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Client</maml:name> <maml:description> <maml:para>The Xurrent PowerShell client instance.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para>No return value.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-XurrentAttachment</command:name> <command:verb>Send</command:verb> <command:noun>XurrentAttachment</command:noun> <command:description> <maml:para>A PowerShell cmdlet for uploading an attachment.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Send-XurrentAttachment cmdlet uploads a file to Xurrent using the specified parameters. The resulting attachment can be referenced in multiple objects.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Send-XurrentAttachment</maml:name> <command:parameter required="true" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The file path of the attachment.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The MIME type of the attachment.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Client</maml:name> <maml:description> <maml:para>The Xurrent PowerShell client instance.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The file path of the attachment.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The MIME type of the attachment.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Client</maml:name> <maml:description> <maml:para>The Xurrent PowerShell client instance.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>The unique identifier of the uploaded attachment.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentAgileBoard</command:name> <command:verb>Set</command:verb> <command:noun>XurrentAgileBoard</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating an agile board.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates an agile board using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentAgileBoard</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ColumnsToDelete</maml:name> <maml:description> <maml:para>Identifiers of columns to remove from the board.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerRepresentativeSlaIds</maml:name> <maml:description> <maml:para>Identifiers of the service level agreements of which the customer representatives can view this board in Self Service.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the agile board.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the board may not be used to place items on.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the manager of the agile board.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the agile board.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>NewColumns</maml:name> <maml:description> <maml:para>Columns of this agile board.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnInput[]</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of agile board properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AgileBoardField[]</command:parameterValue> <dev:type> <maml:name>AgileBoardField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ColumnsToDelete</maml:name> <maml:description> <maml:para>Identifiers of columns to remove from the board.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerRepresentativeSlaIds</maml:name> <maml:description> <maml:para>Identifiers of the service level agreements of which the customer representatives can view this board in Self Service.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the agile board.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the board may not be used to place items on.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the manager of the agile board.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the agile board.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>NewColumns</maml:name> <maml:description> <maml:para>Columns of this agile board.</maml:para> </maml:description> <command:parameterValue required="false">AgileBoardColumnInput[]</command:parameterValue> <dev:type> <maml:name>AgileBoardColumnInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of agile board properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AgileBoardField[]</command:parameterValue> <dev:type> <maml:name>AgileBoardField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardColumnInput[]</maml:name> </dev:type> <maml:description> <maml:para>An agile board column input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgileBoardField[]</maml:name> </dev:type> <maml:description> <maml:para>The agile board field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AgileBoard</maml:name> </dev:type> <maml:description> <maml:para>An agile board object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentAppInstance</command:name> <command:verb>Set</command:verb> <command:noun>XurrentAppInstance</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating an app instance.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates an app instance using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentAppInstance</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomerRepresentativeId</maml:name> <maml:description> <maml:para>Identifier of the contact person of customer regarding this app instance.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the app instance is currently enabled for this customer.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>EnabledByCustomer</maml:name> <maml:description> <maml:para>Whether the customer has enabled this app instance.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Suspended</maml:name> <maml:description> <maml:para>Whether the app instance is currently suspended for this customer.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SuspensionComment</maml:name> <maml:description> <maml:para>Extra information why the app instance is currently suspended for this customer.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of app instance properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppInstanceField[]</command:parameterValue> <dev:type> <maml:name>AppInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomerRepresentativeId</maml:name> <maml:description> <maml:para>Identifier of the contact person of customer regarding this app instance.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the app instance is currently enabled for this customer.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>EnabledByCustomer</maml:name> <maml:description> <maml:para>Whether the customer has enabled this app instance.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Suspended</maml:name> <maml:description> <maml:para>Whether the app instance is currently suspended for this customer.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SuspensionComment</maml:name> <maml:description> <maml:para>Extra information why the app instance is currently suspended for this customer.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of app instance properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppInstanceField[]</command:parameterValue> <dev:type> <maml:name>AppInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppInstanceField[]</maml:name> </dev:type> <maml:description> <maml:para>The app instance field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AppInstance</maml:name> </dev:type> <maml:description> <maml:para>An app instance object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentAppOffering</command:name> <command:verb>Set</command:verb> <command:noun>XurrentAppOffering</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating an app offering.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates an app offering using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentAppOffering</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CardDescription</maml:name> <maml:description> <maml:para>Short description of the app offering to be shown on the card in the App store.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Compliance</maml:name> <maml:description> <maml:para>Compliance description of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationUriTemplate</maml:name> <maml:description> <maml:para>The URI where the app can be configured. The placeholder {account} can be used to include the customer account id in the URI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the app offering may not be used for new instances.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Features</maml:name> <maml:description> <maml:para>Feature description of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>NewScopes</maml:name> <maml:description> <maml:para>Scopes of this app offering</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingScopeInput[]</command:parameterValue> <dev:type> <maml:name>AppOfferingScopeInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>OauthAuthorizationEndpoints</maml:name> <maml:description> <maml:para>The endpoints for the OAuth application that will be created for this app to use in the Authorization Code Grant flow.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PolicyJwtAlg</maml:name> <maml:description> <maml:para>The algorithm used for generating the policy for the app offering's webhook.</maml:para> </maml:description> <command:parameterValue required="false">WebhookPolicyJwtAlg</command:parameterValue> <dev:type> <maml:name>WebhookPolicyJwtAlg</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PolicyJwtAudience</maml:name> <maml:description> <maml:para>The audience for the policy for the app offering's webhook.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PolicyJwtClaimExpiresIn</maml:name> <maml:description> <maml:para>The claim expiry time for the policy for the app offering's webhook.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Reference</maml:name> <maml:description> <maml:para>This reference can be used to link the app offering to an instance using the Xurrent APIs or the Xurrent Import functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>RequiresEnabledOauthPerson</maml:name> <maml:description> <maml:para>This app requires an enabled OAuth person.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ScopesToDelete</maml:name> <maml:description> <maml:para>Identifiers of scopes to remove from the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the the service instance this app offering is linked to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>UiExtensionVersionId</maml:name> <maml:description> <maml:para>Identifier of the UI extension version that is linked to the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>WebhookUriTemplate</maml:name> <maml:description> <maml:para>The URI for the app offering's webhook. The placeholder {account} can be used to include the customer account id in the URI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="25"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of app offering properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CardDescription</maml:name> <maml:description> <maml:para>Short description of the app offering to be shown on the card in the App store.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Compliance</maml:name> <maml:description> <maml:para>Compliance description of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationUriTemplate</maml:name> <maml:description> <maml:para>The URI where the app can be configured. The placeholder {account} can be used to include the customer account id in the URI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the app offering may not be used for new instances.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Features</maml:name> <maml:description> <maml:para>Feature description of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>NewScopes</maml:name> <maml:description> <maml:para>Scopes of this app offering</maml:para> </maml:description> <command:parameterValue required="false">AppOfferingScopeInput[]</command:parameterValue> <dev:type> <maml:name>AppOfferingScopeInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>OauthAuthorizationEndpoints</maml:name> <maml:description> <maml:para>The endpoints for the OAuth application that will be created for this app to use in the Authorization Code Grant flow.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PolicyJwtAlg</maml:name> <maml:description> <maml:para>The algorithm used for generating the policy for the app offering's webhook.</maml:para> </maml:description> <command:parameterValue required="false">WebhookPolicyJwtAlg</command:parameterValue> <dev:type> <maml:name>WebhookPolicyJwtAlg</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PolicyJwtAudience</maml:name> <maml:description> <maml:para>The audience for the policy for the app offering's webhook.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PolicyJwtClaimExpiresIn</maml:name> <maml:description> <maml:para>The claim expiry time for the policy for the app offering's webhook.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Reference</maml:name> <maml:description> <maml:para>This reference can be used to link the app offering to an instance using the Xurrent APIs or the Xurrent Import functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>RequiresEnabledOauthPerson</maml:name> <maml:description> <maml:para>This app requires an enabled OAuth person.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ScopesToDelete</maml:name> <maml:description> <maml:para>Identifiers of scopes to remove from the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the the service instance this app offering is linked to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>UiExtensionVersionId</maml:name> <maml:description> <maml:para>Identifier of the UI extension version that is linked to the app offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>WebhookUriTemplate</maml:name> <maml:description> <maml:para>The URI for the app offering's webhook. The placeholder {account} can be used to include the customer account id in the URI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="25"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of app offering properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingScopeInput[]</maml:name> </dev:type> <maml:description> <maml:para>An app offering scope input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookPolicyJwtAlg</maml:name> </dev:type> <maml:description> <maml:para>A webhook policy JSON web token alg object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingField[]</maml:name> </dev:type> <maml:description> <maml:para>The app offering field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AppOffering</maml:name> </dev:type> <maml:description> <maml:para>An app offering object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentAppOfferingAutomationRule</command:name> <command:verb>Set</command:verb> <command:noun>XurrentAppOfferingAutomationRule</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating an app offering automation rule.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates an app offering automation rule using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentAppOfferingAutomationRule</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Actions</maml:name> <maml:description> <maml:para>The Actions field is used to define actions that should be executed when the condition of the automation rule is met.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleActionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Condition</maml:name> <maml:description> <maml:para>The Condition field is used to define the condition that needs to be met in order for the update action(s) of the rule to be performed. For example: is_assigned and !badge.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the automation rule's function.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Expressions</maml:name> <maml:description> <maml:para>The Expressions field is used to define expressions that can subsequently be used to define the rule's conditions and the update action(s) that the rule is to perform.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleExpressionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Generic</maml:name> <maml:description> <maml:para>The record type this rule is linked to.Valid values are:• request• task• ci</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the automation rule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Position</maml:name> <maml:description> <maml:para>The Position field dictates the order in which the automation rule is executed.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>The Trigger field is used to specify when the automation rule is to be triggered, for example on status update or on note added.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of app offering automation rule properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingAutomationRuleField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingAutomationRuleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Actions</maml:name> <maml:description> <maml:para>The Actions field is used to define actions that should be executed when the condition of the automation rule is met.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleActionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Condition</maml:name> <maml:description> <maml:para>The Condition field is used to define the condition that needs to be met in order for the update action(s) of the rule to be performed. For example: is_assigned and !badge.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the automation rule's function.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Expressions</maml:name> <maml:description> <maml:para>The Expressions field is used to define expressions that can subsequently be used to define the rule's conditions and the update action(s) that the rule is to perform.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleExpressionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Generic</maml:name> <maml:description> <maml:para>The record type this rule is linked to.Valid values are:• request• task• ci</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the automation rule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Position</maml:name> <maml:description> <maml:para>The Position field dictates the order in which the automation rule is executed.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>The Trigger field is used to specify when the automation rule is to be triggered, for example on status update or on note added.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of app offering automation rule properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AppOfferingAutomationRuleField[]</command:parameterValue> <dev:type> <maml:name>AppOfferingAutomationRuleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleActionInput[]</maml:name> </dev:type> <maml:description> <maml:para>An automation rule action input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleExpressionInput[]</maml:name> </dev:type> <maml:description> <maml:para>An automation rule expression input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AppOfferingAutomationRuleField[]</maml:name> </dev:type> <maml:description> <maml:para>The app offering automation rule field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AppOfferingAutomationRule</maml:name> </dev:type> <maml:description> <maml:para>An app offering automation rule object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentAutomationRule</command:name> <command:verb>Set</command:verb> <command:noun>XurrentAutomationRule</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating an automation rule.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates an automation rule using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentAutomationRule</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Actions</maml:name> <maml:description> <maml:para>The Actions field is used to define actions that should be executed when the condition of the automation rule is met.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleActionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Condition</maml:name> <maml:description> <maml:para>The Condition field is used to define the condition that needs to be met in order for the update action(s) of the rule to be performed. For example: is_assigned and !badge.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the automation rule's function.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the automation rule should not be triggered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Expressions</maml:name> <maml:description> <maml:para>The Expressions field is used to define expressions that can subsequently be used to define the rule's conditions and the update action(s) that the rule is to perform.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleExpressionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Generic</maml:name> <maml:description> <maml:para>When the automation rule is not linked to one specific record but to all records of a type, the Generic field contains the record type. Valid values are:• request• problem• workflow• task• project_task• ci• risk• scim_user• scim_group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the automation rule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>The record that the automation rule is linked to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Position</maml:name> <maml:description> <maml:para>The Position field dictates the order in which the automation rule is executed.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>The Trigger field is used to specify when the automation rule is to be triggered, for example on status update or on note added.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="14"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of automation rule properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AutomationRuleField[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Actions</maml:name> <maml:description> <maml:para>The Actions field is used to define actions that should be executed when the condition of the automation rule is met.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleActionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleActionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Condition</maml:name> <maml:description> <maml:para>The Condition field is used to define the condition that needs to be met in order for the update action(s) of the rule to be performed. For example: is_assigned and !badge.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the automation rule's function.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the automation rule should not be triggered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Expressions</maml:name> <maml:description> <maml:para>The Expressions field is used to define expressions that can subsequently be used to define the rule's conditions and the update action(s) that the rule is to perform.</maml:para> </maml:description> <command:parameterValue required="false">AutomationRuleExpressionInput[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleExpressionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Generic</maml:name> <maml:description> <maml:para>When the automation rule is not linked to one specific record but to all records of a type, the Generic field contains the record type. Valid values are:• request• problem• workflow• task• project_task• ci• risk• scim_user• scim_group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the automation rule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>The record that the automation rule is linked to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Position</maml:name> <maml:description> <maml:para>The Position field dictates the order in which the automation rule is executed.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>The Trigger field is used to specify when the automation rule is to be triggered, for example on status update or on note added.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="14"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of automation rule properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AutomationRuleField[]</command:parameterValue> <dev:type> <maml:name>AutomationRuleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleActionInput[]</maml:name> </dev:type> <maml:description> <maml:para>An automation rule action input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleExpressionInput[]</maml:name> </dev:type> <maml:description> <maml:para>An automation rule expression input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AutomationRuleField[]</maml:name> </dev:type> <maml:description> <maml:para>The automation rule field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AutomationRule</maml:name> </dev:type> <maml:description> <maml:para>An automation rule object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentBroadcast</command:name> <command:verb>Set</command:verb> <command:noun>XurrentBroadcast</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a broadcast.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a broadcast using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentBroadcast</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Body</maml:name> <maml:description> <maml:para>The body for the email broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerIds</maml:name> <maml:description> <maml:para>The customer organizations when the broadcast is to be displayed for the specialists of the account in requests that were received from the selected organizations. This is available only when the "Specialists in requests from the following customers" visibility option is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the message should not be broadcasted.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EmailTemplateId</maml:name> <maml:description> <maml:para>The id of the email template used for the email broadcast. This email template needs to be of the type Send Email from Broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>The end date and time of the broadcast. This field is left empty when the message is to be broadcasted until the Disabled box is checked. (If the broadcast should end at midnight at the end of a day, specify 12:00am or 24:00.)</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Message</maml:name> <maml:description> <maml:para>Message that is to be broadcasted in the language of the account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MessageType</maml:name> <maml:description> <maml:para>The appropriate icon for the message. The selected icon is displayed alongside the message when the broadcast is presented.</maml:para> </maml:description> <command:parameterValue required="false">BroadcastMessageType</command:parameterValue> <dev:type> <maml:name>BroadcastMessageType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>The ids of the organizations, to which people belong, that need to see the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the broadcast that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Files and inline images linked to the Remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>The request group to which end users can subscribe when they are also affected by the issue for which the broadcast was created.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>The service instances for which the people, who are covered for them by an active SLA, need to see the broadcast. This is available only when the "People covered for the following service instance(s)" visibility option is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SiteIds</maml:name> <maml:description> <maml:para>The ids of the sites to which people belong and that need to see the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>The ids of the skill pools to which people belong and that need to see the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SlaIds</maml:name> <maml:description> <maml:para>The ids of the service level agreements for which the customer representatives will receive the email broadcast. This is only available for broadcasts when the message type "email" is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The start date and time of the broadcast. (If the broadcast should start at midnight at the start of a day, specify 00:00.)</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Subject</maml:name> <maml:description> <maml:para>The subject for the email broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>TeamIds</maml:name> <maml:description> <maml:para>The teams which members need to see the broadcast. This is available only when the "Members of the following team(s)" visibility option is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the dates and times specified in the Start and End fields.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>TranslationsToDelete</maml:name> <maml:description> <maml:para>Identifiers of translations to remove from this broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Defines the target audience of the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">BroadcastVisibility</command:parameterValue> <dev:type> <maml:name>BroadcastVisibility</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="25"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of broadcast properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BroadcastField[]</command:parameterValue> <dev:type> <maml:name>BroadcastField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Body</maml:name> <maml:description> <maml:para>The body for the email broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerIds</maml:name> <maml:description> <maml:para>The customer organizations when the broadcast is to be displayed for the specialists of the account in requests that were received from the selected organizations. This is available only when the "Specialists in requests from the following customers" visibility option is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the message should not be broadcasted.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EmailTemplateId</maml:name> <maml:description> <maml:para>The id of the email template used for the email broadcast. This email template needs to be of the type Send Email from Broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>The end date and time of the broadcast. This field is left empty when the message is to be broadcasted until the Disabled box is checked. (If the broadcast should end at midnight at the end of a day, specify 12:00am or 24:00.)</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Message</maml:name> <maml:description> <maml:para>Message that is to be broadcasted in the language of the account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MessageType</maml:name> <maml:description> <maml:para>The appropriate icon for the message. The selected icon is displayed alongside the message when the broadcast is presented.</maml:para> </maml:description> <command:parameterValue required="false">BroadcastMessageType</command:parameterValue> <dev:type> <maml:name>BroadcastMessageType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>The ids of the organizations, to which people belong, that need to see the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the broadcast that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>Files and inline images linked to the Remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>The request group to which end users can subscribe when they are also affected by the issue for which the broadcast was created.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>The service instances for which the people, who are covered for them by an active SLA, need to see the broadcast. This is available only when the "People covered for the following service instance(s)" visibility option is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SiteIds</maml:name> <maml:description> <maml:para>The ids of the sites to which people belong and that need to see the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>The ids of the skill pools to which people belong and that need to see the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SlaIds</maml:name> <maml:description> <maml:para>The ids of the service level agreements for which the customer representatives will receive the email broadcast. This is only available for broadcasts when the message type "email" is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The start date and time of the broadcast. (If the broadcast should start at midnight at the start of a day, specify 00:00.)</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Subject</maml:name> <maml:description> <maml:para>The subject for the email broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>TeamIds</maml:name> <maml:description> <maml:para>The teams which members need to see the broadcast. This is available only when the "Members of the following team(s)" visibility option is selected.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the dates and times specified in the Start and End fields.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>TranslationsToDelete</maml:name> <maml:description> <maml:para>Identifiers of translations to remove from this broadcast.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Defines the target audience of the broadcast.</maml:para> </maml:description> <command:parameterValue required="false">BroadcastVisibility</command:parameterValue> <dev:type> <maml:name>BroadcastVisibility</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="25"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of broadcast properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BroadcastField[]</command:parameterValue> <dev:type> <maml:name>BroadcastField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.BroadcastMessageType</maml:name> </dev:type> <maml:description> <maml:para>A broadcast message type object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.BroadcastVisibility</maml:name> </dev:type> <maml:description> <maml:para>A broadcast visibility object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.BroadcastField[]</maml:name> </dev:type> <maml:description> <maml:para>The broadcast field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Broadcast</maml:name> </dev:type> <maml:description> <maml:para>A broadcast object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentCalendar</command:name> <command:verb>Set</command:verb> <command:noun>XurrentCalendar</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a calendar.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a calendar using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentCalendar</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CalendarHoursToDelete</maml:name> <maml:description> <maml:para>Identifiers of calendar hours to remove from the calendar.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the calendar may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>HolidayIds</maml:name> <maml:description> <maml:para>Identifiers of the holidays of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>NewCalendarHours</maml:name> <maml:description> <maml:para>Calendar hours of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">CalendarHoursInput[]</command:parameterValue> <dev:type> <maml:name>CalendarHoursInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of calendar properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CalendarField[]</command:parameterValue> <dev:type> <maml:name>CalendarField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CalendarHoursToDelete</maml:name> <maml:description> <maml:para>Identifiers of calendar hours to remove from the calendar.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the calendar may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>HolidayIds</maml:name> <maml:description> <maml:para>Identifiers of the holidays of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>NewCalendarHours</maml:name> <maml:description> <maml:para>Calendar hours of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">CalendarHoursInput[]</command:parameterValue> <dev:type> <maml:name>CalendarHoursInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of calendar properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CalendarField[]</command:parameterValue> <dev:type> <maml:name>CalendarField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarHoursInput[]</maml:name> </dev:type> <maml:description> <maml:para>A calendar hours input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CalendarField[]</maml:name> </dev:type> <maml:description> <maml:para>The calendar field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Calendar</maml:name> </dev:type> <maml:description> <maml:para>A calendar object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentConfigurationItem</command:name> <command:verb>Set</command:verb> <command:noun>XurrentConfigurationItem</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a configuration item.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a configuration item using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentConfigurationItem</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AlternateNames</maml:name> <maml:description> <maml:para>Alternate names the configuration item is also known by.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AssetID</maml:name> <maml:description> <maml:para>Asset identifier of the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CiRelationsToDelete</maml:name> <maml:description> <maml:para>Identifiers of relations other configuration items to remove from the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ContractIds</maml:name> <maml:description> <maml:para>Identifiers of the contracts of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>EndOfSupportDate</maml:name> <maml:description> <maml:para>The date at which the support for this configuration item ends.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>FinancialOwnerId</maml:name> <maml:description> <maml:para>Identifier of the internal organization which budget is used to pay for the configuration item. If the CI is leased or rented, the organization that pays the lease or rent is selected in this field. When creating a new CI and a value is not specified for this field, it is set to the financial owner of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>InUseSince</maml:name> <maml:description> <maml:para>The date on which the expense for the configuration item (CI) was incurred or, if the CI is depreciated over time, the date on which the depreciation was started. This is typically the invoice date.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Label</maml:name> <maml:description> <maml:para>The label that is attached to the configuration item (CI). A label is automatically generated using the same prefix of other CIs of the same product category, followed by the next available number as the suffix.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>LastSeenAt</maml:name> <maml:description> <maml:para>The date and time at which the configuration item was last seen.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>LicensedSiteIds</maml:name> <maml:description> <maml:para>Identifiers of the sites at which the software that is covered by the license certificate may be used.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>LicenseExpiryDate</maml:name> <maml:description> <maml:para>The date through which the temporary software license certificate is valid. The license certificate expires at the end of this day.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>LicenseType</maml:name> <maml:description> <maml:para>The type of license that the license certificate covers.</maml:para> </maml:description> <command:parameterValue required="false">CiLicenseType</command:parameterValue> <dev:type> <maml:name>CiLicenseType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Location</maml:name> <maml:description> <maml:para>The name or number of the room in which the CI is located, if it concerns a hardware CI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the configuration item (CI). When creating a new CI and a value is not specified for this field, it is set to the name of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>NewCiRelations</maml:name> <maml:description> <maml:para>Relations to other configuration items.</maml:para> </maml:description> <command:parameterValue required="false">CiRelationInput[]</command:parameterValue> <dev:type> <maml:name>CiRelationInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>NrOfCores</maml:name> <maml:description> <maml:para>The total number of processor cores that are installed in the server.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>NrOfLicenses</maml:name> <maml:description> <maml:para>The number of licenses that the license certificate covers.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>NrOfProcessors</maml:name> <maml:description> <maml:para>The number of processors that are installed in the server.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>OperatingSystemId</maml:name> <maml:description> <maml:para>Identifier of the (software) configuration item representing the operating system of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of the related product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>PurchaseValue</maml:name> <maml:description> <maml:para>The amount that was paid for the configuration item (this is normally equal to the invoice amount).</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>PurchaseValueCurrency</maml:name> <maml:description> <maml:para>The currency of the purchase value attributed to this configuration item.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>RamAmount</maml:name> <maml:description> <maml:para>The amount of RAM (in GB) of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for maintenance of the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceInput</command:parameterValue> <dev:type> <maml:name>RecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the configuration item that might prove useful. When creating a new CI and a value is not specified for this field, it is set to the remarks of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>RuleSet</maml:name> <maml:description> <maml:para>The Rule set field is automatically set to the rule set of product category, except when the CI is a license certificate, in which case the rule set is license_certificate.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryRuleSet</command:parameterValue> <dev:type> <maml:name>ProductCategoryRuleSet</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SerialNr</maml:name> <maml:description> <maml:para>Serial number of the configuration item. The concatenation of product's' brand and serialNr must be unique within a Xurrent account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Which service instance(s) the configuration item is, or will be, a part of. When creating a new CI and a value is not specified for this field, it is set to the service of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of the service instances of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>SiteId</maml:name> <maml:description> <maml:para>Where the CI is located, if it concerns a hardware CI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>SiteLicense</maml:name> <maml:description> <maml:para>true for license certificates that may only be used at one or more specific locations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>Status</maml:name> <maml:description> <maml:para>The appropriate status for the configuration item (CI).</maml:para> </maml:description> <command:parameterValue required="false">CiStatus</command:parameterValue> <dev:type> <maml:name>CiStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier from which the configuration item (CI) has been obtained. When creating a new CI and a value is not specified for this field, it is set to the supplier of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team responsible for supporting the configuration item and maintaining its information in the configuration management database (CMDB). When creating a new CI and a value is not specified for this field, it is set to the support team of the CI's product. Optional when status of CI equals "Removed", required otherwise.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>SystemID</maml:name> <maml:description> <maml:para>System identifier of the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>TemporaryLicense</maml:name> <maml:description> <maml:para>true for license certificates that are not valid indefinitely.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>UserIds</maml:name> <maml:description> <maml:para>Identifiers of the users of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>WarrantyExpiryDate</maml:name> <maml:description> <maml:para>The date through which the warranty coverage for the configuration item is valid. The warranty expires at the end of this day.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="46"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>The person who will be responsible for coordinating the workflows that will be generated automatically in accordance with the recurrence schedule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="47"> <maml:name>WorkflowTemplateId</maml:name> <maml:description> <maml:para>The workflow template that is used to periodically maintain the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="48"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of configuration item properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ConfigurationItemField[]</command:parameterValue> <dev:type> <maml:name>ConfigurationItemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="49"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AlternateNames</maml:name> <maml:description> <maml:para>Alternate names the configuration item is also known by.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AssetID</maml:name> <maml:description> <maml:para>Asset identifier of the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CiRelationsToDelete</maml:name> <maml:description> <maml:para>Identifiers of relations other configuration items to remove from the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ContractIds</maml:name> <maml:description> <maml:para>Identifiers of the contracts of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>EndOfSupportDate</maml:name> <maml:description> <maml:para>The date at which the support for this configuration item ends.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>FinancialOwnerId</maml:name> <maml:description> <maml:para>Identifier of the internal organization which budget is used to pay for the configuration item. If the CI is leased or rented, the organization that pays the lease or rent is selected in this field. When creating a new CI and a value is not specified for this field, it is set to the financial owner of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>InUseSince</maml:name> <maml:description> <maml:para>The date on which the expense for the configuration item (CI) was incurred or, if the CI is depreciated over time, the date on which the depreciation was started. This is typically the invoice date.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Label</maml:name> <maml:description> <maml:para>The label that is attached to the configuration item (CI). A label is automatically generated using the same prefix of other CIs of the same product category, followed by the next available number as the suffix.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>LastSeenAt</maml:name> <maml:description> <maml:para>The date and time at which the configuration item was last seen.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>LicensedSiteIds</maml:name> <maml:description> <maml:para>Identifiers of the sites at which the software that is covered by the license certificate may be used.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>LicenseExpiryDate</maml:name> <maml:description> <maml:para>The date through which the temporary software license certificate is valid. The license certificate expires at the end of this day.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>LicenseType</maml:name> <maml:description> <maml:para>The type of license that the license certificate covers.</maml:para> </maml:description> <command:parameterValue required="false">CiLicenseType</command:parameterValue> <dev:type> <maml:name>CiLicenseType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Location</maml:name> <maml:description> <maml:para>The name or number of the room in which the CI is located, if it concerns a hardware CI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the configuration item (CI). When creating a new CI and a value is not specified for this field, it is set to the name of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>NewCiRelations</maml:name> <maml:description> <maml:para>Relations to other configuration items.</maml:para> </maml:description> <command:parameterValue required="false">CiRelationInput[]</command:parameterValue> <dev:type> <maml:name>CiRelationInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>NrOfCores</maml:name> <maml:description> <maml:para>The total number of processor cores that are installed in the server.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>NrOfLicenses</maml:name> <maml:description> <maml:para>The number of licenses that the license certificate covers.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>NrOfProcessors</maml:name> <maml:description> <maml:para>The number of processors that are installed in the server.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>OperatingSystemId</maml:name> <maml:description> <maml:para>Identifier of the (software) configuration item representing the operating system of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of the related product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>PurchaseValue</maml:name> <maml:description> <maml:para>The amount that was paid for the configuration item (this is normally equal to the invoice amount).</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>PurchaseValueCurrency</maml:name> <maml:description> <maml:para>The currency of the purchase value attributed to this configuration item.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>RamAmount</maml:name> <maml:description> <maml:para>The amount of RAM (in GB) of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for maintenance of the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceInput</command:parameterValue> <dev:type> <maml:name>RecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the configuration item that might prove useful. When creating a new CI and a value is not specified for this field, it is set to the remarks of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>RuleSet</maml:name> <maml:description> <maml:para>The Rule set field is automatically set to the rule set of product category, except when the CI is a license certificate, in which case the rule set is license_certificate.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryRuleSet</command:parameterValue> <dev:type> <maml:name>ProductCategoryRuleSet</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SerialNr</maml:name> <maml:description> <maml:para>Serial number of the configuration item. The concatenation of product's' brand and serialNr must be unique within a Xurrent account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Which service instance(s) the configuration item is, or will be, a part of. When creating a new CI and a value is not specified for this field, it is set to the service of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of the service instances of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>SiteId</maml:name> <maml:description> <maml:para>Where the CI is located, if it concerns a hardware CI.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>SiteLicense</maml:name> <maml:description> <maml:para>true for license certificates that may only be used at one or more specific locations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>Status</maml:name> <maml:description> <maml:para>The appropriate status for the configuration item (CI).</maml:para> </maml:description> <command:parameterValue required="false">CiStatus</command:parameterValue> <dev:type> <maml:name>CiStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier from which the configuration item (CI) has been obtained. When creating a new CI and a value is not specified for this field, it is set to the supplier of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team responsible for supporting the configuration item and maintaining its information in the configuration management database (CMDB). When creating a new CI and a value is not specified for this field, it is set to the support team of the CI's product. Optional when status of CI equals "Removed", required otherwise.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>SystemID</maml:name> <maml:description> <maml:para>System identifier of the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>TemporaryLicense</maml:name> <maml:description> <maml:para>true for license certificates that are not valid indefinitely.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>UserIds</maml:name> <maml:description> <maml:para>Identifiers of the users of this configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>WarrantyExpiryDate</maml:name> <maml:description> <maml:para>The date through which the warranty coverage for the configuration item is valid. The warranty expires at the end of this day.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="46"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>The person who will be responsible for coordinating the workflows that will be generated automatically in accordance with the recurrence schedule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="47"> <maml:name>WorkflowTemplateId</maml:name> <maml:description> <maml:para>The workflow template that is used to periodically maintain the configuration item.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="48"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of configuration item properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ConfigurationItemField[]</command:parameterValue> <dev:type> <maml:name>ConfigurationItemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="49"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CiLicenseType</maml:name> </dev:type> <maml:description> <maml:para>A ci license type object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CiRelationInput[]</maml:name> </dev:type> <maml:description> <maml:para>A ci relation input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecurrenceInput</maml:name> </dev:type> <maml:description> <maml:para>A recurrence input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductCategoryRuleSet</maml:name> </dev:type> <maml:description> <maml:para>A product category rule set object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CiStatus</maml:name> </dev:type> <maml:description> <maml:para>A ci status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ConfigurationItemField[]</maml:name> </dev:type> <maml:description> <maml:para>The configuration item field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ConfigurationItem</maml:name> </dev:type> <maml:description> <maml:para>A configuration item object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentContract</command:name> <command:verb>Set</command:verb> <command:noun>XurrentContract</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a contract.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a contract using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentContract</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>Used to select the appropriate category for the contract.</maml:para> </maml:description> <command:parameterValue required="false">ContractCategory</command:parameterValue> <dev:type> <maml:name>ContractCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the contract.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization that pays for the contract.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomerRepresentativeId</maml:name> <maml:description> <maml:para>Identifier of the person who represents the customer of the contract.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ExpiryDate</maml:name> <maml:description> <maml:para>The date through which the contract will be active. The contract expires at the end of this day if it is not renewed before then.When the contract has expired, its status will automatically be set to expired.As long as notice still needs to be given to terminate the contract, the expiryDate field is to remain empty.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the contract.If a unique ID is given to each contract, then this ID can be added at the start of the name.Example:• 2EGXQ2W – Dell 3-Year ProSupport and Next Business Day Onsite Repair for CMP00035</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>NoticeDate</maml:name> <maml:description> <maml:para>The last day on which the supplier organization can still be contacted to terminate the contract to ensure that it expires on the intended expiry date.The noticeDate field is left empty, and the expiryDate field is filled out, when the contract is to expire on a specific date and no notice needs to be given to terminate it.As long as notice still needs to be given to terminate the contract, the expiryDate field is to remain empty.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the contract that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The first day during which the contract is active.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the contract.</maml:para> </maml:description> <command:parameterValue required="false">AgreementStatus</command:parameterValue> <dev:type> <maml:name>AgreementStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SupplierContactId</maml:name> <maml:description> <maml:para>Identifier of the person who represents the supplier of the contract.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the organization that has provided the contract to the customer.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the start date, notice date and expiry date of the contract.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="21"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of contract properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ContractField[]</command:parameterValue> <dev:type> <maml:name>ContractField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>Used to select the appropriate category for the contract.</maml:para> </maml:description> <command:parameterValue required="false">ContractCategory</command:parameterValue> <dev:type> <maml:name>ContractCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the contract.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization that pays for the contract.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomerRepresentativeId</maml:name> <maml:description> <maml:para>Identifier of the person who represents the customer of the contract.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ExpiryDate</maml:name> <maml:description> <maml:para>The date through which the contract will be active. The contract expires at the end of this day if it is not renewed before then.When the contract has expired, its status will automatically be set to expired.As long as notice still needs to be given to terminate the contract, the expiryDate field is to remain empty.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the contract.If a unique ID is given to each contract, then this ID can be added at the start of the name.Example:• 2EGXQ2W – Dell 3-Year ProSupport and Next Business Day Onsite Repair for CMP00035</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>NoticeDate</maml:name> <maml:description> <maml:para>The last day on which the supplier organization can still be contacted to terminate the contract to ensure that it expires on the intended expiry date.The noticeDate field is left empty, and the expiryDate field is filled out, when the contract is to expire on a specific date and no notice needs to be given to terminate it.As long as notice still needs to be given to terminate the contract, the expiryDate field is to remain empty.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the contract that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The first day during which the contract is active.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the contract.</maml:para> </maml:description> <command:parameterValue required="false">AgreementStatus</command:parameterValue> <dev:type> <maml:name>AgreementStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SupplierContactId</maml:name> <maml:description> <maml:para>Identifier of the person who represents the supplier of the contract.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the organization that has provided the contract to the customer.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the start date, notice date and expiry date of the contract.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="21"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of contract properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ContractField[]</command:parameterValue> <dev:type> <maml:name>ContractField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContractCategory</maml:name> </dev:type> <maml:description> <maml:para>A contract category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgreementStatus</maml:name> </dev:type> <maml:description> <maml:para>An agreement status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContractField[]</maml:name> </dev:type> <maml:description> <maml:para>The contract field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Contract</maml:name> </dev:type> <maml:description> <maml:para>A contract object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentCustomCollection</command:name> <command:verb>Set</command:verb> <command:noun>XurrentCustomCollection</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a custom collection.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a custom collection using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentCustomCollection</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CollectionElementsToDelete</maml:name> <maml:description> <maml:para>Identifiers of elements to remove from the collection.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the collection.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the collection may not be used for new custom views.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the collection.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>NewCollectionElements</maml:name> <maml:description> <maml:para>Elements of this custom collection.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionElementInput[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Reference</maml:name> <maml:description> <maml:para>The Reference field defaults to the Name field value, written in lower case characters and with all spaces replaced by the underscore character. This reference can be used to link the collection to an element using the Xurrent APIs or the Xurrent Import functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of custom collection properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomCollectionField[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CollectionElementsToDelete</maml:name> <maml:description> <maml:para>Identifiers of elements to remove from the collection.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the collection.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the collection may not be used for new custom views.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the collection.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>NewCollectionElements</maml:name> <maml:description> <maml:para>Elements of this custom collection.</maml:para> </maml:description> <command:parameterValue required="false">CustomCollectionElementInput[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Reference</maml:name> <maml:description> <maml:para>The Reference field defaults to the Name field value, written in lower case characters and with all spaces replaced by the underscore character. This reference can be used to link the collection to an element using the Xurrent APIs or the Xurrent Import functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of custom collection properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomCollectionField[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionElementInput[]</maml:name> </dev:type> <maml:description> <maml:para>A custom collection element input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionField[]</maml:name> </dev:type> <maml:description> <maml:para>The custom collection field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom collection object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentCustomCollectionElement</command:name> <command:verb>Set</command:verb> <command:noun>XurrentCustomCollectionElement</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a custom collection element.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a custom collection element using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentCustomCollectionElement</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the collection element.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the collection element may not be referenced from custom fields of other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the element that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the collection element.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Reference</maml:name> <maml:description> <maml:para>The Reference field defaults to the Name field value, written in lower case characters and with all spaces replaced by the underscore character.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="12"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of custom collection element properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomCollectionElementField[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the collection element.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the collection element may not be referenced from custom fields of other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the element that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the collection element.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Reference</maml:name> <maml:description> <maml:para>The Reference field defaults to the Name field value, written in lower case characters and with all spaces replaced by the underscore character.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="12"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of custom collection element properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CustomCollectionElementField[]</command:parameterValue> <dev:type> <maml:name>CustomCollectionElementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomCollectionElementField[]</maml:name> </dev:type> <maml:description> <maml:para>The custom collection element field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomCollectionElement</maml:name> </dev:type> <maml:description> <maml:para>A custom collection element object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentEffortClass</command:name> <command:verb>Set</command:verb> <command:noun>XurrentEffortClass</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating an effort class.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates an effort class using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentEffortClass</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CostMultiplier</maml:name> <maml:description> <maml:para>The amount with which to multiply the cost of time entries with this effort class.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the effort class may no longer be related to any more timesheet settings.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the effort class.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the effort class takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ServiceOfferingIds</maml:name> <maml:description> <maml:para>IDs of the service offerings of this effort class.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>IDs of the skill pools of this effort class.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>TimesheetSettingIds</maml:name> <maml:description> <maml:para>IDs of the timesheet settings of this effort class.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of effort class properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EffortClassField[]</command:parameterValue> <dev:type> <maml:name>EffortClassField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CostMultiplier</maml:name> <maml:description> <maml:para>The amount with which to multiply the cost of time entries with this effort class.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the effort class may no longer be related to any more timesheet settings.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the effort class.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the effort class takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ServiceOfferingIds</maml:name> <maml:description> <maml:para>IDs of the service offerings of this effort class.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>IDs of the skill pools of this effort class.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>TimesheetSettingIds</maml:name> <maml:description> <maml:para>IDs of the timesheet settings of this effort class.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of effort class properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EffortClassField[]</command:parameterValue> <dev:type> <maml:name>EffortClassField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassField[]</maml:name> </dev:type> <maml:description> <maml:para>The effort class field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>EffortClass</maml:name> </dev:type> <maml:description> <maml:para>An effort class object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentFirstLineSupportAgreement</command:name> <command:verb>Set</command:verb> <command:noun>XurrentFirstLineSupportAgreement</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a first line support agreement.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a first line support agreement using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentFirstLineSupportAgreement</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Charges</maml:name> <maml:description> <maml:para>The amounts that the customer will be charged for the first line support agreement. These can be recurring as well as one-off charges.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization that pays for the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomerRepresentativeId</maml:name> <maml:description> <maml:para>Identifier of the customer representative.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ExpiryDate</maml:name> <maml:description> <maml:para>The date through which the first line support agreement (FLSA) will be active. The FLSA expires at the end of this day if it is not renewed before then. When the FLSA has expired, its status will automatically be set to "Expired".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>FirstCallResolutions</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be completed by the service desk team during their registration.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>NoticeDate</maml:name> <maml:description> <maml:para>The last day on which the first line support provider organization can still be contacted to terminate the first line support agreement (FLSA) to ensure that it expires on the intended expiry date. The Notice date field is left empty, and the Expiry date field is filled out, when the FLSA is to expire on a specific date and no notice needs to be given to terminate it.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>PickupsWithinTarget</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be picked up by the service desk team within the pickup target.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PickupTarget</maml:name> <maml:description> <maml:para>The number of minutes within which a new or existing request that has been assigned to the service desk team is assigned to a specific member within the service desk team, is assigned to another team, or is set to a status other than assigned.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ProviderId</maml:name> <maml:description> <maml:para>Identifier of the organization that provides the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>RejectedSolutions</maml:name> <maml:description> <maml:para>The maximum percentage of requests that were reopened (i.e. which status in the account that is covered by the first line support agreement was updated from completed to another status).</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the first line support agreement that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ServiceDeskOnlyResolutions</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be completed by the service desk team without having been assigned to any other team within the account that is covered by the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ServiceDeskResolutions</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be completed by the service desk team.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceDeskTeamId</maml:name> <maml:description> <maml:para>Identifier of the specific team within the first line support provider organization that provides first line support for the users covered by the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The first day during which the first line support agreement (FLSA) is active.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the first line support agreement (FLSA).</maml:para> </maml:description> <command:parameterValue required="false">AgreementStatus</command:parameterValue> <dev:type> <maml:name>AgreementStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SupportChatPickupTarget</maml:name> <maml:description> <maml:para>The number of minutes within which a new or existing chat request that has been assigned to the service desk team is assigned to a specific member within the service desk team, is assigned to another team, or is set to a status other than assigned.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>SupportHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours during which the service desk team can be contacted for first line support.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>TargetDetails</maml:name> <maml:description> <maml:para>A description of all the targets of the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the start, notice and expiry dates, and to the support hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="26"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of first line support agreement properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FirstLineSupportAgreementField[]</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Charges</maml:name> <maml:description> <maml:para>The amounts that the customer will be charged for the first line support agreement. These can be recurring as well as one-off charges.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization that pays for the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomerRepresentativeId</maml:name> <maml:description> <maml:para>Identifier of the customer representative.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ExpiryDate</maml:name> <maml:description> <maml:para>The date through which the first line support agreement (FLSA) will be active. The FLSA expires at the end of this day if it is not renewed before then. When the FLSA has expired, its status will automatically be set to "Expired".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>FirstCallResolutions</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be completed by the service desk team during their registration.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>NoticeDate</maml:name> <maml:description> <maml:para>The last day on which the first line support provider organization can still be contacted to terminate the first line support agreement (FLSA) to ensure that it expires on the intended expiry date. The Notice date field is left empty, and the Expiry date field is filled out, when the FLSA is to expire on a specific date and no notice needs to be given to terminate it.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>PickupsWithinTarget</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be picked up by the service desk team within the pickup target.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PickupTarget</maml:name> <maml:description> <maml:para>The number of minutes within which a new or existing request that has been assigned to the service desk team is assigned to a specific member within the service desk team, is assigned to another team, or is set to a status other than assigned.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ProviderId</maml:name> <maml:description> <maml:para>Identifier of the organization that provides the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>RejectedSolutions</maml:name> <maml:description> <maml:para>The maximum percentage of requests that were reopened (i.e. which status in the account that is covered by the first line support agreement was updated from completed to another status).</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the first line support agreement that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ServiceDeskOnlyResolutions</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be completed by the service desk team without having been assigned to any other team within the account that is covered by the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ServiceDeskResolutions</maml:name> <maml:description> <maml:para>The minimum percentage of requests that are to be completed by the service desk team.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceDeskTeamId</maml:name> <maml:description> <maml:para>Identifier of the specific team within the first line support provider organization that provides first line support for the users covered by the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The first day during which the first line support agreement (FLSA) is active.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the first line support agreement (FLSA).</maml:para> </maml:description> <command:parameterValue required="false">AgreementStatus</command:parameterValue> <dev:type> <maml:name>AgreementStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SupportChatPickupTarget</maml:name> <maml:description> <maml:para>The number of minutes within which a new or existing chat request that has been assigned to the service desk team is assigned to a specific member within the service desk team, is assigned to another team, or is set to a status other than assigned.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>SupportHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours during which the service desk team can be contacted for first line support.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>TargetDetails</maml:name> <maml:description> <maml:para>A description of all the targets of the first line support agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the start, notice and expiry dates, and to the support hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="26"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of first line support agreement properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FirstLineSupportAgreementField[]</command:parameterValue> <dev:type> <maml:name>FirstLineSupportAgreementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgreementStatus</maml:name> </dev:type> <maml:description> <maml:para>An agreement status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.FirstLineSupportAgreementField[]</maml:name> </dev:type> <maml:description> <maml:para>The first line support agreement field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>FirstLineSupportAgreement</maml:name> </dev:type> <maml:description> <maml:para>A first line support agreement object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentHoliday</command:name> <command:verb>Set</command:verb> <command:noun>XurrentHoliday</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a holiday.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a holiday using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentHoliday</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CalendarIds</maml:name> <maml:description> <maml:para>Identifiers of calendars of the holiday.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>End of the holiday.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the holiday.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Start of the holiday.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of holiday properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">HolidayField[]</command:parameterValue> <dev:type> <maml:name>HolidayField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CalendarIds</maml:name> <maml:description> <maml:para>Identifiers of calendars of the holiday.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>End of the holiday.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the holiday.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Start of the holiday.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of holiday properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">HolidayField[]</command:parameterValue> <dev:type> <maml:name>HolidayField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.HolidayField[]</maml:name> </dev:type> <maml:description> <maml:para>The holiday field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Holiday</maml:name> </dev:type> <maml:description> <maml:para>A holiday object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentInvoice</command:name> <command:verb>Set</command:verb> <command:noun>XurrentInvoice</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating an invoice.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates an invoice using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentInvoice</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AmortizationEnd</maml:name> <maml:description> <maml:para>The end date of the period over which the invoice is to be amortized.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AmortizationStart</maml:name> <maml:description> <maml:para>The start date of the period over which the invoice is to be amortized.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Amortize</maml:name> <maml:description> <maml:para>Whether the invoice amount is to be amortized over time.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CiIds</maml:name> <maml:description> <maml:para>The configuration items linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ContractId</maml:name> <maml:description> <maml:para>The contract linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Currency</maml:name> <maml:description> <maml:para>Currency of the amount value of the invoice.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DepreciationMethod</maml:name> <maml:description> <maml:para>Used to specify whether or not configuration items that are linked to this invoice are depreciatedand if so, which depreciation method is to be applied. Valid values are:• not_depreciated: Not Depreciated• double_declining_balance: Double Declining Balance• reducing_balance: Reducing Balance (or Diminishing Value)• straight_line: Straight Line (or Prime Cost)• sum_of_the_years_digits: Sum of the Year's Digits</maml:para> </maml:description> <command:parameterValue required="false">ProductDepreciationMethod</command:parameterValue> <dev:type> <maml:name>ProductDepreciationMethod</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DepreciationStart</maml:name> <maml:description> <maml:para>The date on which to start depreciating the asset.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Description</maml:name> <maml:description> <maml:para>Short description of what was acquired.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FinancialID</maml:name> <maml:description> <maml:para>The unique identifier by which the invoice is known in the financial system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>FlsaId</maml:name> <maml:description> <maml:para>The first line support agreement linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>InvoiceDate</maml:name> <maml:description> <maml:para>The date on which the invoice was sent out by the supplier.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>InvoiceNr</maml:name> <maml:description> <maml:para>The invoice number that the supplier specified on the invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PoNr</maml:name> <maml:description> <maml:para>Number of the purchase order that was used to order the (lease of the) configuration item from the supplier.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>The project linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Quantity</maml:name> <maml:description> <maml:para>The number of units that were acquired.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Rate</maml:name> <maml:description> <maml:para>Used to specify the yearly rate that should be applied to calculate the depreciation of the configuration item (CI) using the reducing balance (or diminishing value) method. When creating a new CI and a value is not specified for this field, it is set to the rate of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the invoice that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SalvageValue</maml:name> <maml:description> <maml:para>The value of this configuration item at the end of its useful life (i.e. at the end of its depreciation period). When a value is not specified for this field, it is set to zero.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SalvageValueCurrency</maml:name> <maml:description> <maml:para>The currency of the salvage value attributed to this configuration item.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>The service that covers this invoice. Can only be set when the invoice is linked to a contract or configuration items.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>SlaId</maml:name> <maml:description> <maml:para>The service level agreement linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the organization from which the invoice was received.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>UnitPrice</maml:name> <maml:description> <maml:para>The amount that the supplier has charged per unit that was acquired.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>UsefulLife</maml:name> <maml:description> <maml:para>The number of years within which the configuration item is to be depreciated. When creating a new CI and a value is not specified for this field, it is set to the useful life of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>The workflow linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="31"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of invoice properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InvoiceField[]</command:parameterValue> <dev:type> <maml:name>InvoiceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AmortizationEnd</maml:name> <maml:description> <maml:para>The end date of the period over which the invoice is to be amortized.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AmortizationStart</maml:name> <maml:description> <maml:para>The start date of the period over which the invoice is to be amortized.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Amortize</maml:name> <maml:description> <maml:para>Whether the invoice amount is to be amortized over time.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CiIds</maml:name> <maml:description> <maml:para>The configuration items linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ContractId</maml:name> <maml:description> <maml:para>The contract linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Currency</maml:name> <maml:description> <maml:para>Currency of the amount value of the invoice.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DepreciationMethod</maml:name> <maml:description> <maml:para>Used to specify whether or not configuration items that are linked to this invoice are depreciatedand if so, which depreciation method is to be applied. Valid values are:• not_depreciated: Not Depreciated• double_declining_balance: Double Declining Balance• reducing_balance: Reducing Balance (or Diminishing Value)• straight_line: Straight Line (or Prime Cost)• sum_of_the_years_digits: Sum of the Year's Digits</maml:para> </maml:description> <command:parameterValue required="false">ProductDepreciationMethod</command:parameterValue> <dev:type> <maml:name>ProductDepreciationMethod</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DepreciationStart</maml:name> <maml:description> <maml:para>The date on which to start depreciating the asset.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Description</maml:name> <maml:description> <maml:para>Short description of what was acquired.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FinancialID</maml:name> <maml:description> <maml:para>The unique identifier by which the invoice is known in the financial system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>FlsaId</maml:name> <maml:description> <maml:para>The first line support agreement linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>InvoiceDate</maml:name> <maml:description> <maml:para>The date on which the invoice was sent out by the supplier.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>InvoiceNr</maml:name> <maml:description> <maml:para>The invoice number that the supplier specified on the invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PoNr</maml:name> <maml:description> <maml:para>Number of the purchase order that was used to order the (lease of the) configuration item from the supplier.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>The project linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Quantity</maml:name> <maml:description> <maml:para>The number of units that were acquired.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Rate</maml:name> <maml:description> <maml:para>Used to specify the yearly rate that should be applied to calculate the depreciation of the configuration item (CI) using the reducing balance (or diminishing value) method. When creating a new CI and a value is not specified for this field, it is set to the rate of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the invoice that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SalvageValue</maml:name> <maml:description> <maml:para>The value of this configuration item at the end of its useful life (i.e. at the end of its depreciation period). When a value is not specified for this field, it is set to zero.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SalvageValueCurrency</maml:name> <maml:description> <maml:para>The currency of the salvage value attributed to this configuration item.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>The service that covers this invoice. Can only be set when the invoice is linked to a contract or configuration items.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>SlaId</maml:name> <maml:description> <maml:para>The service level agreement linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the organization from which the invoice was received.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>UnitPrice</maml:name> <maml:description> <maml:para>The amount that the supplier has charged per unit that was acquired.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>UsefulLife</maml:name> <maml:description> <maml:para>The number of years within which the configuration item is to be depreciated. When creating a new CI and a value is not specified for this field, it is set to the useful life of the CI's product.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>The workflow linked to this invoice.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="31"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of invoice properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InvoiceField[]</command:parameterValue> <dev:type> <maml:name>InvoiceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductDepreciationMethod</maml:name> </dev:type> <maml:description> <maml:para>A product depreciation method object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.InvoiceField[]</maml:name> </dev:type> <maml:description> <maml:para>The invoice field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Invoice</maml:name> </dev:type> <maml:description> <maml:para>An invoice object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentKnowledgeArticle</command:name> <command:verb>Set</command:verb> <command:noun>XurrentKnowledgeArticle</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a knowledge article.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a knowledge article using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentKnowledgeArticle</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ArchiveDate</maml:name> <maml:description> <maml:para>The date until which the knowledge article will be active. The knowledge article will be archived at the beginning of this day. When the knowledge article is archived, its status will automatically be set to "Archived".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CoveredSpecialists</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to the people who are a member of the support team of one of the service instances that are selected in the Coverage section of an active SLA for the service that is linked to the article.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CreatedById</maml:name> <maml:description> <maml:para>Identifier of the person who created the knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Description</maml:name> <maml:description> <maml:para>Describes the situation and/or environment in which the instructions of the knowledge article may be helpful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>EndUsers</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to anyone who is covered by an active SLA for the service that is linked to the article.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Used to enter instructions for the service desk analysts, specialists and/or end users who are likely to look up the knowledge article to help them with their work or to resolve an issue.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>InternalSpecialists</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to the people who have the Specialist role of the account in which the article is registered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>KeyContacts</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to the people who have the Key Contact role of the customer account of an active SLA for the service that is linked to the article.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Keywords</maml:name> <maml:description> <maml:para>A comma-separated list of words that can be used to find the knowledge article using search.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Public</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to anyone, including people without access to Xurrent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the knowledge article is made available.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of service instances linked to this knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleStatus</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>Identifier of the knowledge article template that this knowledge article is based on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>TranslationsToDelete</maml:name> <maml:description> <maml:para>Identifiers of translations to remove from this knowledge articles.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="23"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of knowledge article properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">KnowledgeArticleField[]</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ArchiveDate</maml:name> <maml:description> <maml:para>The date until which the knowledge article will be active. The knowledge article will be archived at the beginning of this day. When the knowledge article is archived, its status will automatically be set to "Archived".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CoveredSpecialists</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to the people who are a member of the support team of one of the service instances that are selected in the Coverage section of an active SLA for the service that is linked to the article.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CreatedById</maml:name> <maml:description> <maml:para>Identifier of the person who created the knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Description</maml:name> <maml:description> <maml:para>Describes the situation and/or environment in which the instructions of the knowledge article may be helpful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>EndUsers</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to anyone who is covered by an active SLA for the service that is linked to the article.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Used to enter instructions for the service desk analysts, specialists and/or end users who are likely to look up the knowledge article to help them with their work or to resolve an issue.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>InternalSpecialists</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to the people who have the Specialist role of the account in which the article is registered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>KeyContacts</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to the people who have the Key Contact role of the customer account of an active SLA for the service that is linked to the article.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Keywords</maml:name> <maml:description> <maml:para>A comma-separated list of words that can be used to find the knowledge article using search.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Public</maml:name> <maml:description> <maml:para>Whether the knowledge article needs to be available to anyone, including people without access to Xurrent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the knowledge article is made available.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of service instances linked to this knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">KnowledgeArticleStatus</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the knowledge article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>Identifier of the knowledge article template that this knowledge article is based on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>TranslationsToDelete</maml:name> <maml:description> <maml:para>Identifiers of translations to remove from this knowledge articles.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="23"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of knowledge article properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">KnowledgeArticleField[]</command:parameterValue> <dev:type> <maml:name>KnowledgeArticleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleStatus</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.KnowledgeArticleField[]</maml:name> </dev:type> <maml:description> <maml:para>The knowledge article field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>KnowledgeArticle</maml:name> </dev:type> <maml:description> <maml:para>A knowledge article object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentOrganization</command:name> <command:verb>Set</command:verb> <command:noun>XurrentOrganization</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating an organization.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates an organization using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentOrganization</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AddressesToDelete</maml:name> <maml:description> <maml:para>Identifiers of addresses to remove from the organization.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>BusinessUnit</maml:name> <maml:description> <maml:para>Whether the organization needs to be treated as a separate entity from a reporting perspective. This checkbox is only available for internal organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>BusinessUnitOrganizationId</maml:name> <maml:description> <maml:para>Refers to itself if the organization is a business unit, or refers to the business unit that the organization belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ContactsToDelete</maml:name> <maml:description> <maml:para>Identifiers of contacts to remove from the organization.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the organization may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>EndUserPrivacy</maml:name> <maml:description> <maml:para>Whether end users from this organization should be prevented from seeing information of other end users.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>FinancialID</maml:name> <maml:description> <maml:para>The unique identifier by which the organization is known in the financial system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager of the organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Name</maml:name> <maml:description> <maml:para>The full name of the organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of the organization.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>NewContacts</maml:name> <maml:description> <maml:para>New or updated contacts of the organization.</maml:para> </maml:description> <command:parameterValue required="false">ContactInput[]</command:parameterValue> <dev:type> <maml:name>ContactInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ParentId</maml:name> <maml:description> <maml:para>The organization's parent organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Region</maml:name> <maml:description> <maml:para>Which region the organization belongs to. It is possible to select a previously entered region name or to enter a new one. The Region field of a business unit's child organizations cannot be modified, as it is automatically set to the same value as the Region field of the business unit.Examples of commonly used region names are:- Asia Pacific (APAC)- Europe, Middle East & Africa (EMEA)- North America (NA)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the organization that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SubstituteId</maml:name> <maml:description> <maml:para>The person who acts as the substitute of the organization's manager.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>TimeAllocationIds</maml:name> <maml:description> <maml:para>Time allocations of the organization.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="25"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of organization properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">OrganizationField[]</command:parameterValue> <dev:type> <maml:name>OrganizationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AddressesToDelete</maml:name> <maml:description> <maml:para>Identifiers of addresses to remove from the organization.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>BusinessUnit</maml:name> <maml:description> <maml:para>Whether the organization needs to be treated as a separate entity from a reporting perspective. This checkbox is only available for internal organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>BusinessUnitOrganizationId</maml:name> <maml:description> <maml:para>Refers to itself if the organization is a business unit, or refers to the business unit that the organization belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ContactsToDelete</maml:name> <maml:description> <maml:para>Identifiers of contacts to remove from the organization.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the organization may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>EndUserPrivacy</maml:name> <maml:description> <maml:para>Whether end users from this organization should be prevented from seeing information of other end users.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>FinancialID</maml:name> <maml:description> <maml:para>The unique identifier by which the organization is known in the financial system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager of the organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Name</maml:name> <maml:description> <maml:para>The full name of the organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of the organization.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>NewContacts</maml:name> <maml:description> <maml:para>New or updated contacts of the organization.</maml:para> </maml:description> <command:parameterValue required="false">ContactInput[]</command:parameterValue> <dev:type> <maml:name>ContactInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ParentId</maml:name> <maml:description> <maml:para>The organization's parent organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Region</maml:name> <maml:description> <maml:para>Which region the organization belongs to. It is possible to select a previously entered region name or to enter a new one. The Region field of a business unit's child organizations cannot be modified, as it is automatically set to the same value as the Region field of the business unit.Examples of commonly used region names are:- Asia Pacific (APAC)- Europe, Middle East & Africa (EMEA)- North America (NA)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the organization that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SubstituteId</maml:name> <maml:description> <maml:para>The person who acts as the substitute of the organization's manager.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>TimeAllocationIds</maml:name> <maml:description> <maml:para>Time allocations of the organization.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="25"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of organization properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">OrganizationField[]</command:parameterValue> <dev:type> <maml:name>OrganizationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressInput[]</maml:name> </dev:type> <maml:description> <maml:para>An address input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContactInput[]</maml:name> </dev:type> <maml:description> <maml:para>A contact input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OrganizationField[]</maml:name> </dev:type> <maml:description> <maml:para>The organization field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Organization</maml:name> </dev:type> <maml:description> <maml:para>An organization object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentOutOfOfficePeriod</command:name> <command:verb>Set</command:verb> <command:noun>XurrentOutOfOfficePeriod</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating an out of office period.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates an out of office period using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentOutOfOfficePeriod</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ApprovalDelegateId</maml:name> <maml:description> <maml:para>Identifier of the person who is selected as the approval delegate for the out of office period.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Used to generate time entries for the out of office period. This field is required if the timesheet settings linked to the person's organization has one or more effort classes.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>End time of the out of office period.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person who is out of office.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Reason</maml:name> <maml:description> <maml:para>The reason of the out of office period. Required when the description category of the time allocation is required.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Start time of the out of office period.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>TimeAllocationId</maml:name> <maml:description> <maml:para>Used to generate time entries for the out of office period. Only the time allocations without service and customer that are linked to the person's organization can be selected. This field is required if at least one time allocation exists that meets those conditions.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of out of office period properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">OutOfOfficePeriodField[]</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ApprovalDelegateId</maml:name> <maml:description> <maml:para>Identifier of the person who is selected as the approval delegate for the out of office period.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Used to generate time entries for the out of office period. This field is required if the timesheet settings linked to the person's organization has one or more effort classes.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>End time of the out of office period.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person who is out of office.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Reason</maml:name> <maml:description> <maml:para>The reason of the out of office period. Required when the description category of the time allocation is required.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Start time of the out of office period.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>TimeAllocationId</maml:name> <maml:description> <maml:para>Used to generate time entries for the out of office period. Only the time allocations without service and customer that are linked to the person's organization can be selected. This field is required if at least one time allocation exists that meets those conditions.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of out of office period properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">OutOfOfficePeriodField[]</command:parameterValue> <dev:type> <maml:name>OutOfOfficePeriodField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.OutOfOfficePeriodField[]</maml:name> </dev:type> <maml:description> <maml:para>The out of office period field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OutOfOfficePeriod</maml:name> </dev:type> <maml:description> <maml:para>An out of office period object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentPdfDesign</command:name> <command:verb>Set</command:verb> <command:noun>XurrentPdfDesign</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a pdf design.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a pdf design using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentPdfDesign</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>Category of the design.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignCategory</command:parameterValue> <dev:type> <maml:name>PdfDesignCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Css</maml:name> <maml:description> <maml:para>CSS of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Files and inline images linked to the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the design is to be used.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Html</maml:name> <maml:description> <maml:para>HTML of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of pdf design properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PdfDesignField[]</command:parameterValue> <dev:type> <maml:name>PdfDesignField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>Category of the design.</maml:para> </maml:description> <command:parameterValue required="false">PdfDesignCategory</command:parameterValue> <dev:type> <maml:name>PdfDesignCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Css</maml:name> <maml:description> <maml:para>CSS of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>Files and inline images linked to the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the design is to be used.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Html</maml:name> <maml:description> <maml:para>HTML of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the design.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of pdf design properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PdfDesignField[]</command:parameterValue> <dev:type> <maml:name>PdfDesignField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PdfDesignCategory</maml:name> </dev:type> <maml:description> <maml:para>A pdf design category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PdfDesignField[]</maml:name> </dev:type> <maml:description> <maml:para>The pdf design field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PdfDesign</maml:name> </dev:type> <maml:description> <maml:para>A pdf design object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentPerson</command:name> <command:verb>Set</command:verb> <command:noun>XurrentPerson</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a person.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a person using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentPerson</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AccountPermissionsToDelete</maml:name> <maml:description> <maml:para>Identifiers of accounts this person's permissions will be deleted for. Permissions for other accounts will not be altered.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AddressesToDelete</maml:name> <maml:description> <maml:para>Identifiers of addresses to remove from this person.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AuthenticationID</maml:name> <maml:description> <maml:para>Uniquely identify the user for Single Sign-On</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AutoTranslation</maml:name> <maml:description> <maml:para>Whether the person should be offered translations for texts that are written in languages other than the ones selected in the Language (language) and the Do not translate (do_not_translate_languages) arguments. Such texts are translated automatically into the language selected in the Language (language) argument.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Configuration items this person is related to as a user.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ContactsToDelete</maml:name> <maml:description> <maml:para>Identifiers of contacts to remove from this person.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CostPerHour</maml:name> <maml:description> <maml:para>The person's estimated total cost per work hour for the service provider organization. The value in this argument should include the costs of the person's salary (or rate in case of a long-term contractor), office space, service subscriptions, training, etc.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CostPerHourCurrency</maml:name> <maml:description> <maml:para>The currency of the cost per hour value attributed to this person.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>true when the person may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>DoNotTranslateLanguages</maml:name> <maml:description> <maml:para>The languages that should not be translated automatically for the person. Translations will not be offered to the person for texts in any of these languages. Supported language codes are: en, nl, de, fr, es, pt, it, da, fi, sv, pl, cs, tr, ru, ar, id, fa, no, zh, ja, ko, he, hi, ms.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>EmployeeID</maml:name> <maml:description> <maml:para>The unique identifier for a person typically based on order of hire or association with an organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ExcludeTeamNotifications</maml:name> <maml:description> <maml:para>Whether team notifications should be excluded from all notifications.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the person that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>JobTitle</maml:name> <maml:description> <maml:para>The person's job title.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Language</maml:name> <maml:description> <maml:para>The language preference of the person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Location</maml:name> <maml:description> <maml:para>The name or number of the room, cubicle or area where the person has his/her primary work space.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager or supervisor to whom the person reports.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>NewAccountPermissions</maml:name> <maml:description> <maml:para>Permissions for specific accounts of this person to add or update. Permissions for other accounts will not be altered.</maml:para> </maml:description> <command:parameterValue required="false">PermissionInput[]</command:parameterValue> <dev:type> <maml:name>PermissionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of this person.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>NewContacts</maml:name> <maml:description> <maml:para>New or updated contacts of this person.</maml:para> </maml:description> <command:parameterValue required="false">ContactInput[]</command:parameterValue> <dev:type> <maml:name>ContactInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>OauthPersonEnablement</maml:name> <maml:description> <maml:para>An enabled OAuth person is mentionable and visible in suggest fields, just like a real person.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>The organization for which the person works as an employee or long-term contractor.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Permissions</maml:name> <maml:description> <maml:para>Permissions of this person. These will overwrite all existing permissions of this person.</maml:para> </maml:description> <command:parameterValue required="false">PermissionInput[]</command:parameterValue> <dev:type> <maml:name>PermissionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>PrimaryEmail</maml:name> <maml:description> <maml:para>The email address to which email notifications are to be sent. This email address acts as the unique identifier for the person within the Xurrent account. This primary email address also acts as the person's login name if he/she is a user of the Xurrent service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>SendEmailNotifications</maml:name> <maml:description> <maml:para>Indicates when to send email notifications to the person.</maml:para> </maml:description> <command:parameterValue required="false">PersonSendEmailNotifications</command:parameterValue> <dev:type> <maml:name>PersonSendEmailNotifications</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>ShowNotificationPopup</maml:name> <maml:description> <maml:para>Indicates when to show a notification popup to the person.</maml:para> </maml:description> <command:parameterValue required="false">PersonShowNotificationPopup</command:parameterValue> <dev:type> <maml:name>PersonShowNotificationPopup</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>SiteId</maml:name> <maml:description> <maml:para>Where the person is stationed.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>Skill pools this person belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>SupportID</maml:name> <maml:description> <maml:para>A number or code that a service desk analyst can ask the person for when the person contacts the service desk for support.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>TeamIds</maml:name> <maml:description> <maml:para>Teams this person belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>TimeFormat24h</maml:name> <maml:description> <maml:para>Whether the person prefers to see times displayed within the Xurrent service in the 24-hour format or not (in which case the 12-hour format is applied).</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone in which the person normally resides.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>Vip</maml:name> <maml:description> <maml:para>Whether the person is a very important person.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>WorkHoursId</maml:name> <maml:description> <maml:para>Calendar that represents the work hours of the person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="44"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of person properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PersonField[]</command:parameterValue> <dev:type> <maml:name>PersonField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AccountPermissionsToDelete</maml:name> <maml:description> <maml:para>Identifiers of accounts this person's permissions will be deleted for. Permissions for other accounts will not be altered.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AddressesToDelete</maml:name> <maml:description> <maml:para>Identifiers of addresses to remove from this person.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AuthenticationID</maml:name> <maml:description> <maml:para>Uniquely identify the user for Single Sign-On</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AutoTranslation</maml:name> <maml:description> <maml:para>Whether the person should be offered translations for texts that are written in languages other than the ones selected in the Language (language) and the Do not translate (do_not_translate_languages) arguments. Such texts are translated automatically into the language selected in the Language (language) argument.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Configuration items this person is related to as a user.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ContactsToDelete</maml:name> <maml:description> <maml:para>Identifiers of contacts to remove from this person.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CostPerHour</maml:name> <maml:description> <maml:para>The person's estimated total cost per work hour for the service provider organization. The value in this argument should include the costs of the person's salary (or rate in case of a long-term contractor), office space, service subscriptions, training, etc.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CostPerHourCurrency</maml:name> <maml:description> <maml:para>The currency of the cost per hour value attributed to this person.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>true when the person may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>DoNotTranslateLanguages</maml:name> <maml:description> <maml:para>The languages that should not be translated automatically for the person. Translations will not be offered to the person for texts in any of these languages. Supported language codes are: en, nl, de, fr, es, pt, it, da, fi, sv, pl, cs, tr, ru, ar, id, fa, no, zh, ja, ko, he, hi, ms.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>EmployeeID</maml:name> <maml:description> <maml:para>The unique identifier for a person typically based on order of hire or association with an organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ExcludeTeamNotifications</maml:name> <maml:description> <maml:para>Whether team notifications should be excluded from all notifications.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the person that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>JobTitle</maml:name> <maml:description> <maml:para>The person's job title.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Language</maml:name> <maml:description> <maml:para>The language preference of the person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Location</maml:name> <maml:description> <maml:para>The name or number of the room, cubicle or area where the person has his/her primary work space.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager or supervisor to whom the person reports.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>NewAccountPermissions</maml:name> <maml:description> <maml:para>Permissions for specific accounts of this person to add or update. Permissions for other accounts will not be altered.</maml:para> </maml:description> <command:parameterValue required="false">PermissionInput[]</command:parameterValue> <dev:type> <maml:name>PermissionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of this person.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>NewContacts</maml:name> <maml:description> <maml:para>New or updated contacts of this person.</maml:para> </maml:description> <command:parameterValue required="false">ContactInput[]</command:parameterValue> <dev:type> <maml:name>ContactInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>OauthPersonEnablement</maml:name> <maml:description> <maml:para>An enabled OAuth person is mentionable and visible in suggest fields, just like a real person.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>The organization for which the person works as an employee or long-term contractor.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Permissions</maml:name> <maml:description> <maml:para>Permissions of this person. These will overwrite all existing permissions of this person.</maml:para> </maml:description> <command:parameterValue required="false">PermissionInput[]</command:parameterValue> <dev:type> <maml:name>PermissionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>PrimaryEmail</maml:name> <maml:description> <maml:para>The email address to which email notifications are to be sent. This email address acts as the unique identifier for the person within the Xurrent account. This primary email address also acts as the person's login name if he/she is a user of the Xurrent service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>SendEmailNotifications</maml:name> <maml:description> <maml:para>Indicates when to send email notifications to the person.</maml:para> </maml:description> <command:parameterValue required="false">PersonSendEmailNotifications</command:parameterValue> <dev:type> <maml:name>PersonSendEmailNotifications</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>ShowNotificationPopup</maml:name> <maml:description> <maml:para>Indicates when to show a notification popup to the person.</maml:para> </maml:description> <command:parameterValue required="false">PersonShowNotificationPopup</command:parameterValue> <dev:type> <maml:name>PersonShowNotificationPopup</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>SiteId</maml:name> <maml:description> <maml:para>Where the person is stationed.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>Skill pools this person belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>SupportID</maml:name> <maml:description> <maml:para>A number or code that a service desk analyst can ask the person for when the person contacts the service desk for support.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>TeamIds</maml:name> <maml:description> <maml:para>Teams this person belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>TimeFormat24h</maml:name> <maml:description> <maml:para>Whether the person prefers to see times displayed within the Xurrent service in the 24-hour format or not (in which case the 12-hour format is applied).</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone in which the person normally resides.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>Vip</maml:name> <maml:description> <maml:para>Whether the person is a very important person.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>WorkHoursId</maml:name> <maml:description> <maml:para>Calendar that represents the work hours of the person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="44"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of person properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PersonField[]</command:parameterValue> <dev:type> <maml:name>PersonField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PermissionInput[]</maml:name> </dev:type> <maml:description> <maml:para>A permission input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressInput[]</maml:name> </dev:type> <maml:description> <maml:para>An address input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ContactInput[]</maml:name> </dev:type> <maml:description> <maml:para>A contact input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonSendEmailNotifications</maml:name> </dev:type> <maml:description> <maml:para>A person send email notifications object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonShowNotificationPopup</maml:name> </dev:type> <maml:description> <maml:para>A person show notification popup object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PersonField[]</maml:name> </dev:type> <maml:description> <maml:para>The person field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Person</maml:name> </dev:type> <maml:description> <maml:para>A person object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentProblem</command:name> <command:verb>Set</command:verb> <command:noun>XurrentProblem</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a problem.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a problem using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentProblem</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AnalysisTargetAt</maml:name> <maml:description> <maml:para>Used to specify when the current assignee needs to have completed the root cause analysis of the problem.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemCategory</command:parameterValue> <dev:type> <maml:name>ProblemCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of configuration items of this problem.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Impact</maml:name> <maml:description> <maml:para>Used to select the extent to which the service is impacted when an incident occurs that is caused by the problem. Defaults to none.</maml:para> </maml:description> <command:parameterValue required="false">ProblemImpact</command:parameterValue> <dev:type> <maml:name>ProblemImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>KnowledgeArticleId</maml:name> <maml:description> <maml:para>Identifier of the knowledge article which instructions should be followed to resolve incidents caused by this problem until a structural solution has been implemented.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>KnownError</maml:name> <maml:description> <maml:para>Whether the underlying cause of the problem has been found and a temporary workaround has been proposed.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the problem through root cause analysis, the proposal of a structural solution and ultimately its closure. Defaults to the current authenticated person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person to whom the problem is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Note</maml:name> <maml:description> <maml:para>Detailed description of the symptoms that are caused by the problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProductBacklogEstimate</maml:name> <maml:description> <maml:para>Estimate of the relative size of this item on the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ProductBacklogId</maml:name> <maml:description> <maml:para>Identifier of the product backlog this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ProductBacklogPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item on the backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>Identifier of the project to link the problem to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>RequestIds</maml:name> <maml:description> <maml:para>Identifiers of requests of this problem.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service in which instance(s) the problem resides.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of service instances of this problem.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemStatus</command:parameterValue> <dev:type> <maml:name>ProblemStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the symptoms that the problem causes.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that has been asked for a solution to the problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request to help with the solution of the problem has been registered at the supplier organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team to which the problem is to be assigned. Defaults to the support team of the service if no team or member is present.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether the problem has been marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the problem is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>Workaround</maml:name> <maml:description> <maml:para>Used to describe the temporary workaround that should be applied to resolve incidents caused by this problem until a structural solution has been implemented.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>Identifier of the workflow that will implement the proposed permanent solution for the problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="37"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of problem properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProblemField[]</command:parameterValue> <dev:type> <maml:name>ProblemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AnalysisTargetAt</maml:name> <maml:description> <maml:para>Used to specify when the current assignee needs to have completed the root cause analysis of the problem.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemCategory</command:parameterValue> <dev:type> <maml:name>ProblemCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of configuration items of this problem.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Impact</maml:name> <maml:description> <maml:para>Used to select the extent to which the service is impacted when an incident occurs that is caused by the problem. Defaults to none.</maml:para> </maml:description> <command:parameterValue required="false">ProblemImpact</command:parameterValue> <dev:type> <maml:name>ProblemImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>KnowledgeArticleId</maml:name> <maml:description> <maml:para>Identifier of the knowledge article which instructions should be followed to resolve incidents caused by this problem until a structural solution has been implemented.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>KnownError</maml:name> <maml:description> <maml:para>Whether the underlying cause of the problem has been found and a temporary workaround has been proposed.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the problem through root cause analysis, the proposal of a structural solution and ultimately its closure. Defaults to the current authenticated person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person to whom the problem is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Note</maml:name> <maml:description> <maml:para>Detailed description of the symptoms that are caused by the problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProductBacklogEstimate</maml:name> <maml:description> <maml:para>Estimate of the relative size of this item on the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ProductBacklogId</maml:name> <maml:description> <maml:para>Identifier of the product backlog this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ProductBacklogPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item on the backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>Identifier of the project to link the problem to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>RequestIds</maml:name> <maml:description> <maml:para>Identifiers of requests of this problem.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service in which instance(s) the problem resides.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of service instances of this problem.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the problem.</maml:para> </maml:description> <command:parameterValue required="false">ProblemStatus</command:parameterValue> <dev:type> <maml:name>ProblemStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the symptoms that the problem causes.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that has been asked for a solution to the problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request to help with the solution of the problem has been registered at the supplier organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team to which the problem is to be assigned. Defaults to the support team of the service if no team or member is present.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether the problem has been marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the problem is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>Workaround</maml:name> <maml:description> <maml:para>Used to describe the temporary workaround that should be applied to resolve incidents caused by this problem until a structural solution has been implemented.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>Identifier of the workflow that will implement the proposed permanent solution for the problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="37"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of problem properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProblemField[]</command:parameterValue> <dev:type> <maml:name>ProblemField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemCategory</maml:name> </dev:type> <maml:description> <maml:para>A problem category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemImpact</maml:name> </dev:type> <maml:description> <maml:para>A problem impact object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemStatus</maml:name> </dev:type> <maml:description> <maml:para>A problem status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProblemField[]</maml:name> </dev:type> <maml:description> <maml:para>The problem field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Problem</maml:name> </dev:type> <maml:description> <maml:para>A problem object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentProduct</command:name> <command:verb>Set</command:verb> <command:noun>XurrentProduct</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a product.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a product using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentProduct</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Brand</maml:name> <maml:description> <maml:para>The brand name is typically the name of the product's manufacturer.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Category</maml:name> <maml:description> <maml:para>The appropriate product category for the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>DepreciationMethod</maml:name> <maml:description> <maml:para>Used to specify whether or not configuration items that are based on the product are typically depreciated and if so, which depreciation method is normally applied. Valid values are:• not_depreciated: Not Depreciated• double_declining_balance: Double Declining Balance• reducing_balance: Reducing Balance (or Diminishing Value)• straight_line: Straight Line (or Prime Cost)• sum_of_the_years_digits: Sum of the Year's Digits</maml:para> </maml:description> <command:parameterValue required="false">ProductDepreciationMethod</command:parameterValue> <dev:type> <maml:name>ProductDepreciationMethod</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the product may no longer be used to register new configuration items.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>FinancialOwnerId</maml:name> <maml:description> <maml:para>Identifier of the internal organization which budget is normally used to obtain the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Model</maml:name> <maml:description> <maml:para>The model of the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the product. Fill out the Brand, Model, Product ID (optional) and Category fields to automatically generate a name based on the values entered in these fields.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ProductID</maml:name> <maml:description> <maml:para>The unique identifier of the product that is used by the manufacturer. The concatenation of brand and productID must be unique within a Xurrent account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Rate</maml:name> <maml:description> <maml:para>The yearly rate that should normally be applied to calculate the depreciation of configuration items that are based on the product using the reducing balance (or diminishing value) method.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for maintenance of configuration items created from the product.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceInput</command:parameterValue> <dev:type> <maml:name>RecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the product that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SalvageValue</maml:name> <maml:description> <maml:para>The value of this configuration item at the end of its useful life (i.e. at the end of its depreciation period). When a value is not specified for this field, it is set to zero.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SalvageValueCurrency</maml:name> <maml:description> <maml:para>The currency of the salvage value attributed to this configuration item.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the Service which Service Instances would typically include the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the organization from which the product is typically obtained. If the product is developed internally, select the internal organization that develops it. Note that a lease company should be selected in this field if the product is normally leased.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team responsible for maintaining the product's information in the configuration management database (CMDB).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>UsefulLife</maml:name> <maml:description> <maml:para>The number of years within which configuration items that are based on the product are typically depreciated.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>The person who will be responsible for coordinating the workflows that will be generated automatically in accordance with the recurrence schedule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>WorkflowTemplateId</maml:name> <maml:description> <maml:para>The workflow template that is used to periodically maintain configuration items created from the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="28"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of product properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductField[]</command:parameterValue> <dev:type> <maml:name>ProductField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Brand</maml:name> <maml:description> <maml:para>The brand name is typically the name of the product's manufacturer.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Category</maml:name> <maml:description> <maml:para>The appropriate product category for the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>DepreciationMethod</maml:name> <maml:description> <maml:para>Used to specify whether or not configuration items that are based on the product are typically depreciated and if so, which depreciation method is normally applied. Valid values are:• not_depreciated: Not Depreciated• double_declining_balance: Double Declining Balance• reducing_balance: Reducing Balance (or Diminishing Value)• straight_line: Straight Line (or Prime Cost)• sum_of_the_years_digits: Sum of the Year's Digits</maml:para> </maml:description> <command:parameterValue required="false">ProductDepreciationMethod</command:parameterValue> <dev:type> <maml:name>ProductDepreciationMethod</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the product may no longer be used to register new configuration items.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>FinancialOwnerId</maml:name> <maml:description> <maml:para>Identifier of the internal organization which budget is normally used to obtain the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Model</maml:name> <maml:description> <maml:para>The model of the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the product. Fill out the Brand, Model, Product ID (optional) and Category fields to automatically generate a name based on the values entered in these fields.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ProductID</maml:name> <maml:description> <maml:para>The unique identifier of the product that is used by the manufacturer. The concatenation of brand and productID must be unique within a Xurrent account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Rate</maml:name> <maml:description> <maml:para>The yearly rate that should normally be applied to calculate the depreciation of configuration items that are based on the product using the reducing balance (or diminishing value) method.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for maintenance of configuration items created from the product.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceInput</command:parameterValue> <dev:type> <maml:name>RecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the product that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SalvageValue</maml:name> <maml:description> <maml:para>The value of this configuration item at the end of its useful life (i.e. at the end of its depreciation period). When a value is not specified for this field, it is set to zero.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SalvageValueCurrency</maml:name> <maml:description> <maml:para>The currency of the salvage value attributed to this configuration item.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the Service which Service Instances would typically include the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the organization from which the product is typically obtained. If the product is developed internally, select the internal organization that develops it. Note that a lease company should be selected in this field if the product is normally leased.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team responsible for maintaining the product's information in the configuration management database (CMDB).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>UsefulLife</maml:name> <maml:description> <maml:para>The number of years within which configuration items that are based on the product are typically depreciated.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>The person who will be responsible for coordinating the workflows that will be generated automatically in accordance with the recurrence schedule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>WorkflowTemplateId</maml:name> <maml:description> <maml:para>The workflow template that is used to periodically maintain configuration items created from the product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="28"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of product properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductField[]</command:parameterValue> <dev:type> <maml:name>ProductField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductDepreciationMethod</maml:name> </dev:type> <maml:description> <maml:para>A product depreciation method object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecurrenceInput</maml:name> </dev:type> <maml:description> <maml:para>A recurrence input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductField[]</maml:name> </dev:type> <maml:description> <maml:para>The product field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Product</maml:name> </dev:type> <maml:description> <maml:para>A product object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentProductBacklog</command:name> <command:verb>Set</command:verb> <command:noun>XurrentProductBacklog</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a product backlog.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a product backlog using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentProductBacklog</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the backlog may not be used to place items on.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ProductOwnerId</maml:name> <maml:description> <maml:para>Identifier of the person responsible for maximizing the value of the work done based on this product backlog.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of product backlog properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductBacklogField[]</command:parameterValue> <dev:type> <maml:name>ProductBacklogField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the backlog may not be used to place items on.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ProductOwnerId</maml:name> <maml:description> <maml:para>Identifier of the person responsible for maximizing the value of the work done based on this product backlog.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of product backlog properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductBacklogField[]</command:parameterValue> <dev:type> <maml:name>ProductBacklogField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductBacklogField[]</maml:name> </dev:type> <maml:description> <maml:para>The product backlog field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProductBacklog</maml:name> </dev:type> <maml:description> <maml:para>A product backlog object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentProductCategory</command:name> <command:verb>Set</command:verb> <command:noun>XurrentProductCategory</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a product category.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a product category using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentProductCategory</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the product category may not be related to any more products.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Group</maml:name> <maml:description> <maml:para>Used to include the product category in a group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the product category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>RuleSet</maml:name> <maml:description> <maml:para>Used to select a set of rules that are to be applied to the products to which the product category is related, as well as the configuration items that are related to those products. The selected rule set dictates which fields are available for these product and configuration items.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryRuleSet</command:parameterValue> <dev:type> <maml:name>ProductCategoryRuleSet</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of product category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductCategoryField[]</command:parameterValue> <dev:type> <maml:name>ProductCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the product category may not be related to any more products.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Group</maml:name> <maml:description> <maml:para>Used to include the product category in a group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the product category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>RuleSet</maml:name> <maml:description> <maml:para>Used to select a set of rules that are to be applied to the products to which the product category is related, as well as the configuration items that are related to those products. The selected rule set dictates which fields are available for these product and configuration items.</maml:para> </maml:description> <command:parameterValue required="false">ProductCategoryRuleSet</command:parameterValue> <dev:type> <maml:name>ProductCategoryRuleSet</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of product category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProductCategoryField[]</command:parameterValue> <dev:type> <maml:name>ProductCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductCategoryRuleSet</maml:name> </dev:type> <maml:description> <maml:para>A product category rule set object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProductCategoryField[]</maml:name> </dev:type> <maml:description> <maml:para>The product category field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProductCategory</maml:name> </dev:type> <maml:description> <maml:para>A product category object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentProject</command:name> <command:verb>Set</command:verb> <command:noun>XurrentProject</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a project.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a project using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentProject</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>BudgetAllocated</maml:name> <maml:description> <maml:para>Whether the project has been approved and no longer needs to be considered for funding by portfolio management.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>The appropriate completion reason for the project when it has been completed. It is automatically set to "Complete" when all tasks related to the project have reached the status "Completed", "Approved" or "Canceled".</maml:para> </maml:description> <command:parameterValue required="false">ProjectCompletionReason</command:parameterValue> <dev:type> <maml:name>ProjectCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CostOfEffort</maml:name> <maml:description> <maml:para>The estimated cost of the effort that will be needed from internal employees and/or long-term contractors to implement the project.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CostOfPurchases</maml:name> <maml:description> <maml:para>The estimated cost of all purchases (for equipment, consulting effort, licenses, etc.) needed to implement the project. Recurring costs that will be incurred following the implementation of the project are to be included for the entire ROI calculation period.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization for which the project is to be implemented.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Effort</maml:name> <maml:description> <maml:para>The estimated number of hours of effort that will be needed from internal employees and/or long-term contractors to implement the project.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Justification</maml:name> <maml:description> <maml:para>The reason why the project should be considered for implementation.</maml:para> </maml:description> <command:parameterValue required="false">ProjectJustification</command:parameterValue> <dev:type> <maml:name>ProjectJustification</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the implementation of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>NewPhases</maml:name> <maml:description> <maml:para>Phases of the project.</maml:para> </maml:description> <command:parameterValue required="false">ProjectPhaseInput[]</command:parameterValue> <dev:type> <maml:name>ProjectPhaseInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Note</maml:name> <maml:description> <maml:para>High-level description of the project. It is also used to add any information that could prove useful for anyone involved in the project, including the people whose approval is needed and the people who are helping to implement it.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PhasesToDelete</maml:name> <maml:description> <maml:para>Phases to remove from the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProblemIds</maml:name> <maml:description> <maml:para>Identifiers of the problems of the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Program</maml:name> <maml:description> <maml:para>Used to indicate which program the project is a part of.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RequestIds</maml:name> <maml:description> <maml:para>Identifiers of the requests of the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>RiskLevel</maml:name> <maml:description> <maml:para>The risk level of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the project will be implemented.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Status</maml:name> <maml:description> <maml:para>Automatically set based on the status of the project's tasks.</maml:para> </maml:description> <command:parameterValue required="false">ProjectStatus</command:parameterValue> <dev:type> <maml:name>ProjectStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>Identifier of the project template to apply to the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected work hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Value</maml:name> <maml:description> <maml:para>The estimated financial value that the implementation of the project will deliver for the entire ROI calculation period.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>WorkflowIds</maml:name> <maml:description> <maml:para>Identifiers of the workflows of the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>WorkHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the work hours that are to be used to calculate the anticipated assignment and completion target for the tasks of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="31"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectField[]</command:parameterValue> <dev:type> <maml:name>ProjectField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>BudgetAllocated</maml:name> <maml:description> <maml:para>Whether the project has been approved and no longer needs to be considered for funding by portfolio management.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>The appropriate completion reason for the project when it has been completed. It is automatically set to "Complete" when all tasks related to the project have reached the status "Completed", "Approved" or "Canceled".</maml:para> </maml:description> <command:parameterValue required="false">ProjectCompletionReason</command:parameterValue> <dev:type> <maml:name>ProjectCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CostOfEffort</maml:name> <maml:description> <maml:para>The estimated cost of the effort that will be needed from internal employees and/or long-term contractors to implement the project.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CostOfPurchases</maml:name> <maml:description> <maml:para>The estimated cost of all purchases (for equipment, consulting effort, licenses, etc.) needed to implement the project. Recurring costs that will be incurred following the implementation of the project are to be included for the entire ROI calculation period.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization for which the project is to be implemented.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Effort</maml:name> <maml:description> <maml:para>The estimated number of hours of effort that will be needed from internal employees and/or long-term contractors to implement the project.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Justification</maml:name> <maml:description> <maml:para>The reason why the project should be considered for implementation.</maml:para> </maml:description> <command:parameterValue required="false">ProjectJustification</command:parameterValue> <dev:type> <maml:name>ProjectJustification</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the implementation of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>NewPhases</maml:name> <maml:description> <maml:para>Phases of the project.</maml:para> </maml:description> <command:parameterValue required="false">ProjectPhaseInput[]</command:parameterValue> <dev:type> <maml:name>ProjectPhaseInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Note</maml:name> <maml:description> <maml:para>High-level description of the project. It is also used to add any information that could prove useful for anyone involved in the project, including the people whose approval is needed and the people who are helping to implement it.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PhasesToDelete</maml:name> <maml:description> <maml:para>Phases to remove from the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProblemIds</maml:name> <maml:description> <maml:para>Identifiers of the problems of the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Program</maml:name> <maml:description> <maml:para>Used to indicate which program the project is a part of.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RequestIds</maml:name> <maml:description> <maml:para>Identifiers of the requests of the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>RiskLevel</maml:name> <maml:description> <maml:para>The risk level of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the project will be implemented.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Status</maml:name> <maml:description> <maml:para>Automatically set based on the status of the project's tasks.</maml:para> </maml:description> <command:parameterValue required="false">ProjectStatus</command:parameterValue> <dev:type> <maml:name>ProjectStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>Identifier of the project template to apply to the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected work hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Value</maml:name> <maml:description> <maml:para>The estimated financial value that the implementation of the project will deliver for the entire ROI calculation period.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>WorkflowIds</maml:name> <maml:description> <maml:para>Identifiers of the workflows of the project.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>WorkHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the work hours that are to be used to calculate the anticipated assignment and completion target for the tasks of the project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="31"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectField[]</command:parameterValue> <dev:type> <maml:name>ProjectField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectCompletionReason</maml:name> </dev:type> <maml:description> <maml:para>A project completion reason object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectJustification</maml:name> </dev:type> <maml:description> <maml:para>A project justification object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectPhaseInput[]</maml:name> </dev:type> <maml:description> <maml:para>A project phase input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectStatus</maml:name> </dev:type> <maml:description> <maml:para>A project status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectField[]</maml:name> </dev:type> <maml:description> <maml:para>The project field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Project</maml:name> </dev:type> <maml:description> <maml:para>A project object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentProjectCategory</command:name> <command:verb>Set</command:verb> <command:noun>XurrentProjectCategory</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a project category.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a project category using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentProjectCategory</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A very short description of the project category, for example "More than 200 workdays or $200K".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project category may not be related to any more projects.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the project category that might prove useful, especially for project managers when they need to decide which project category to select for a project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project category. Ideally the name of a project category consists of a single word, such as "Large".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the project category takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectCategoryField[]</command:parameterValue> <dev:type> <maml:name>ProjectCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A very short description of the project category, for example "More than 200 workdays or $200K".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project category may not be related to any more projects.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the project category that might prove useful, especially for project managers when they need to decide which project category to select for a project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project category. Ideally the name of a project category consists of a single word, such as "Large".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the project category takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectCategoryField[]</command:parameterValue> <dev:type> <maml:name>ProjectCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectCategoryField[]</maml:name> </dev:type> <maml:description> <maml:para>The project category field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectCategory</maml:name> </dev:type> <maml:description> <maml:para>A project category object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentProjectRiskLevel</command:name> <command:verb>Set</command:verb> <command:noun>XurrentProjectRiskLevel</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a project risk level.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a project risk level using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentProjectRiskLevel</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A very short description of the project risk level, for example "Risk of Failure is Significant".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project risk level may not be related to any more projects.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the project risk level that might prove useful, especially for project managers when they need to decide which project risk level to select for a project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project risk level. Ideally the name of a project risk level consists of a single word, such as "Significant".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the project risk level takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project risk level properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectRiskLevelField[]</command:parameterValue> <dev:type> <maml:name>ProjectRiskLevelField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A very short description of the project risk level, for example "Risk of Failure is Significant".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project risk level may not be related to any more projects.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the project risk level that might prove useful, especially for project managers when they need to decide which project risk level to select for a project.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project risk level. Ideally the name of a project risk level consists of a single word, such as "Significant".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the project risk level takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project risk level properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectRiskLevelField[]</command:parameterValue> <dev:type> <maml:name>ProjectRiskLevelField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectRiskLevelField[]</maml:name> </dev:type> <maml:description> <maml:para>The project risk level field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectRiskLevel</maml:name> </dev:type> <maml:description> <maml:para>A project risk level object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentProjectTask</command:name> <command:verb>Set</command:verb> <command:noun>XurrentProjectTask</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a project task.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a project task using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentProjectTask</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AssignedAt</maml:name> <maml:description> <maml:para>Automatically set to the current date and time when the project task is assigned.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignmentsToDelete</maml:name> <maml:description> <maml:para>Identifiers of assignments to remove from the project task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the project task. Activity tasks are used to assign project-related work to people. Approval tasks are used to collect approvals for projects. Milestones are used to mark specific points along a project's implementation plan.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskCategory</command:parameterValue> <dev:type> <maml:name>ProjectTaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Deadline</maml:name> <maml:description> <maml:para>The date and time at which the milestone needs to have been reached.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Used to provide instructions for the person(s) to whom the project task will be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>NewAssignments</maml:name> <maml:description> <maml:para>Assignments of the project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskAssignmentInput[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskAssignmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Note</maml:name> <maml:description> <maml:para>Used to provide information for the person to whom the project task is assigned. It is also used to provide a summary of the actions that have been taken to date and the results of these actions.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design to link to the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PhaseId</maml:name> <maml:description> <maml:para>Identifier of the phase of the project to which the project task belongs.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>The number of minutes it is expected to take for the project task to be completed following its assignment, or following its fixed start date and time if the Start no earlier than field is filled out.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>The number of minutes the team is expected to spend working on the project task.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PredecessorIds</maml:name> <maml:description> <maml:para>Identifiers of the predecessors of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number of assignees who need to have provided their approval before the status of the project task gets updated to "Approved".</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SkillPoolId</maml:name> <maml:description> <maml:para>Skill pool that represents the specific expertise needed to complete the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Only used when work on the project task may not start before a specific date and time.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskStatus</command:parameterValue> <dev:type> <maml:name>ProjectTaskStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>SuccessorIds</maml:name> <maml:description> <maml:para>Identifiers of the successors of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>The supplier organization that has been asked to assist with the completion of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request to help with the execution of the project task has been registered at the supplier organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>The team to which the project task is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>The project task template that was used to register the project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether the project task is urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the project task is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>When set to true, the completion target of the project task is calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="36"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project task properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AssignedAt</maml:name> <maml:description> <maml:para>Automatically set to the current date and time when the project task is assigned.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignmentsToDelete</maml:name> <maml:description> <maml:para>Identifiers of assignments to remove from the project task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the project task. Activity tasks are used to assign project-related work to people. Approval tasks are used to collect approvals for projects. Milestones are used to mark specific points along a project's implementation plan.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskCategory</command:parameterValue> <dev:type> <maml:name>ProjectTaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Deadline</maml:name> <maml:description> <maml:para>The date and time at which the milestone needs to have been reached.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Used to provide instructions for the person(s) to whom the project task will be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>NewAssignments</maml:name> <maml:description> <maml:para>Assignments of the project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskAssignmentInput[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskAssignmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Note</maml:name> <maml:description> <maml:para>Used to provide information for the person to whom the project task is assigned. It is also used to provide a summary of the actions that have been taken to date and the results of these actions.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design to link to the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PhaseId</maml:name> <maml:description> <maml:para>Identifier of the phase of the project to which the project task belongs.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>The number of minutes it is expected to take for the project task to be completed following its assignment, or following its fixed start date and time if the Start no earlier than field is filled out.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>The number of minutes the team is expected to spend working on the project task.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PredecessorIds</maml:name> <maml:description> <maml:para>Identifiers of the predecessors of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number of assignees who need to have provided their approval before the status of the project task gets updated to "Approved".</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SkillPoolId</maml:name> <maml:description> <maml:para>Skill pool that represents the specific expertise needed to complete the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Only used when work on the project task may not start before a specific date and time.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the project task.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskStatus</command:parameterValue> <dev:type> <maml:name>ProjectTaskStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>SuccessorIds</maml:name> <maml:description> <maml:para>Identifiers of the successors of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>The supplier organization that has been asked to assist with the completion of the project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request to help with the execution of the project task has been registered at the supplier organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>The team to which the project task is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>The project task template that was used to register the project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether the project task is urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the project task is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>When set to true, the completion target of the project task is calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="36"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project task properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskCategory</maml:name> </dev:type> <maml:description> <maml:para>A project task category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskAssignmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>A project task assignment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskStatus</maml:name> </dev:type> <maml:description> <maml:para>A project task status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskField[]</maml:name> </dev:type> <maml:description> <maml:para>The project task field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTask</maml:name> </dev:type> <maml:description> <maml:para>A project task object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentProjectTaskTemplate</command:name> <command:verb>Set</command:verb> <command:noun>XurrentProjectTaskTemplate</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a project task template.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a project task template using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentProjectTaskTemplate</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>Identifier of the Agile board column the project task will be placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>Identifier of the Agile board the project task will be placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AssignmentsToDelete</maml:name> <maml:description> <maml:para>Identifiers of assignments to remove from the project task template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AssignToProjectManager</maml:name> <maml:description> <maml:para>Whether the project manager is to be selected in the Assignees field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignToRequester</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the person who is selected in the Requested for field of the request for which the project was registered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AssignToRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the business unit to which the organization belongs that is linked to the person who is selected in the Requested for field of the request for which the project was registered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AssignToRequesterManager</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the manager of the project's requester.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AssignToServiceOwner</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the person who is selected in the Service owner field of the service that is linked to the project that the new project task is a part of.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskCategory</command:parameterValue> <dev:type> <maml:name>ProjectTaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CopyNotesToProject</maml:name> <maml:description> <maml:para>Whether the Copy note to project box of project tasks that were created based on the template needs to be checked by default. (The Copy notes to project checkbox is called "Copy notes to project by default" when the project task template is in Edit mode.)</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project task template may not be used to help register new project tasks.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a project task created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Instructions field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>NewAssignments</maml:name> <maml:description> <maml:para>Assignments of the project task template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateAssignmentInput[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateAssignmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design that needs to be copied to the PDF design field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that should be entered in the Planned duration field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the team is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PlannedEffortProjectManager</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the project manager is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PlannedEffortRequester</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the requester is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>PlannedEffortRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the requester's business unit manager is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PlannedEffortRequesterManager</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the requester's manager is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>PlannedEffortServiceOwner</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the service owner is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number that needs to be specified in the Required approvals field of a new approval project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>SkillPoolId</maml:name> <maml:description> <maml:para>Identifier of the skill pool that should be selected in the Skill pool field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that should be selected in the Supplier field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the Team that should be selected in the Team field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>When set to true, the completion target of project tasks created based on the template are calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="34"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project task template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskTemplateField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>Identifier of the Agile board column the project task will be placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>Identifier of the Agile board the project task will be placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AssignmentsToDelete</maml:name> <maml:description> <maml:para>Identifiers of assignments to remove from the project task template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AssignToProjectManager</maml:name> <maml:description> <maml:para>Whether the project manager is to be selected in the Assignees field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignToRequester</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the person who is selected in the Requested for field of the request for which the project was registered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AssignToRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the business unit to which the organization belongs that is linked to the person who is selected in the Requested for field of the request for which the project was registered.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>AssignToRequesterManager</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the manager of the project's requester.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>AssignToServiceOwner</maml:name> <maml:description> <maml:para>Whether a new project task that is being created based on the template is to be assigned to the person who is selected in the Service owner field of the service that is linked to the project that the new project task is a part of.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskCategory</command:parameterValue> <dev:type> <maml:name>ProjectTaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>CopyNotesToProject</maml:name> <maml:description> <maml:para>Whether the Copy note to project box of project tasks that were created based on the template needs to be checked by default. (The Copy notes to project checkbox is called "Copy notes to project by default" when the project task template is in Edit mode.)</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project task template may not be used to help register new project tasks.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a project task created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Instructions field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>NewAssignments</maml:name> <maml:description> <maml:para>Assignments of the project task template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTaskTemplateAssignmentInput[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateAssignmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design that needs to be copied to the PDF design field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that should be entered in the Planned duration field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the team is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PlannedEffortProjectManager</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the project manager is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PlannedEffortRequester</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the requester is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>PlannedEffortRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the requester's business unit manager is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PlannedEffortRequesterManager</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the requester's manager is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>PlannedEffortServiceOwner</maml:name> <maml:description> <maml:para>Used to specify the number of minutes that the service owner is expected to spend working on a project task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number that needs to be specified in the Required approvals field of a new approval project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>SkillPoolId</maml:name> <maml:description> <maml:para>Identifier of the skill pool that should be selected in the Skill pool field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that should be selected in the Supplier field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the Team that should be selected in the Team field of a new project task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>When set to true, the completion target of project tasks created based on the template are calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="34"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project task template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTaskTemplateField[]</command:parameterValue> <dev:type> <maml:name>ProjectTaskTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskCategory</maml:name> </dev:type> <maml:description> <maml:para>A project task category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateAssignmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>A project task template assignment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTaskTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The project task template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTaskTemplate</maml:name> </dev:type> <maml:description> <maml:para>A project task template object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentProjectTemplate</command:name> <command:verb>Set</command:verb> <command:noun>XurrentProjectTemplate</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a project template.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a project template using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentProjectTemplate</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project template may not be used to help register new projects.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>NewPhases</maml:name> <maml:description> <maml:para>Phases of the project template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectPhaseInput[]</command:parameterValue> <dev:type> <maml:name>ProjectPhaseInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewTaskTemplateRelations</maml:name> <maml:description> <maml:para>Project task template relations of the project template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplateTaskTemplateInput[]</command:parameterValue> <dev:type> <maml:name>ProjectTemplateTaskTemplateInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PhasesToDelete</maml:name> <maml:description> <maml:para>Identifiers of phases to remove from the project template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new project when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>TaskTemplateRelationsToDelete</maml:name> <maml:description> <maml:para>Identifiers of task template relations to remove from the project template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTemplateField[]</command:parameterValue> <dev:type> <maml:name>ProjectTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the project template may not be used to help register new projects.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>NewPhases</maml:name> <maml:description> <maml:para>Phases of the project template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectPhaseInput[]</command:parameterValue> <dev:type> <maml:name>ProjectPhaseInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewTaskTemplateRelations</maml:name> <maml:description> <maml:para>Project task template relations of the project template.</maml:para> </maml:description> <command:parameterValue required="false">ProjectTemplateTaskTemplateInput[]</command:parameterValue> <dev:type> <maml:name>ProjectTemplateTaskTemplateInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PhasesToDelete</maml:name> <maml:description> <maml:para>Identifiers of phases to remove from the project template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new project when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>TaskTemplateRelationsToDelete</maml:name> <maml:description> <maml:para>Identifiers of task template relations to remove from the project template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of project template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProjectTemplateField[]</command:parameterValue> <dev:type> <maml:name>ProjectTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectPhaseInput[]</maml:name> </dev:type> <maml:description> <maml:para>A project phase input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTemplateTaskTemplateInput[]</maml:name> </dev:type> <maml:description> <maml:para>A project template task template input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ProjectTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The project template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProjectTemplate</maml:name> </dev:type> <maml:description> <maml:para>A project template object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentRelease</command:name> <command:verb>Set</command:verb> <command:noun>XurrentRelease</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a release.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a release using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentRelease</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the implementation of the release. The person must have the release Manager role.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Note</maml:name> <maml:description> <maml:para>High-level description of the result that should be accomplished by the implementation of the release's workflows. It is also used to add any information that could prove useful for anyone affected by the release.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the release.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>WorkflowIds</maml:name> <maml:description> <maml:para>Identifiers of the workflows of the release.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of release properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReleaseField[]</command:parameterValue> <dev:type> <maml:name>ReleaseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the implementation of the release. The person must have the release Manager role.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Note</maml:name> <maml:description> <maml:para>High-level description of the result that should be accomplished by the implementation of the release's workflows. It is also used to add any information that could prove useful for anyone affected by the release.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the release.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>WorkflowIds</maml:name> <maml:description> <maml:para>Identifiers of the workflows of the release.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="11"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of release properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReleaseField[]</command:parameterValue> <dev:type> <maml:name>ReleaseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReleaseField[]</maml:name> </dev:type> <maml:description> <maml:para>The release field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Release</maml:name> </dev:type> <maml:description> <maml:para>A release object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentRequest</command:name> <command:verb>Set</command:verb> <command:noun>XurrentRequest</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a request.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a request using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentRequest</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Addressed</maml:name> <maml:description> <maml:para>Default: false - When the Satisfaction field of the request is set to 'Dissatisfied', a person who has the Service Desk Manager role, can check the Addressed box to indicate that the requester has been conciliated.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Category</maml:name> <maml:description> <maml:para>The Category field is used to select the category of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestCategory</command:parameterValue> <dev:type> <maml:name>RequestCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>The appropriate completion reason for the request when it has been completed.</maml:para> </maml:description> <command:parameterValue required="false">RequestCompletionReason</command:parameterValue> <dev:type> <maml:name>RequestCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items to relate to the request. When this field is used to update an existing request, all configuration items that were linked to this request will be replaced by the supplied configuration items.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>DesiredCompletionAt</maml:name> <maml:description> <maml:para>The date and time that has been agreed on for the completion of the request. The desired completion overwrites the automatically calculated resolution target of any affected SLA that is related to the request when the desired completion is later than the affected SLA's resolution target. By default, the person selected in the Requested by field receives a notification based on the 'Desired Completion Set for Request' email template whenever the value in the Desired completion field is set, updated or removed.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>DowntimeEndAt</maml:name> <maml:description> <maml:para>Used to specify the actual date and time at which the service became available again.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>DowntimeStartAt</maml:name> <maml:description> <maml:para>Used to specify the actual date and time at which the service outage started.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>GroupedIntoId</maml:name> <maml:description> <maml:para>ID of the request group that is used to group the requests that have been submitted for the resolution of exactly the same incident, for the implementation of exactly the same change, for the provision of exactly the same information, etc.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Impact</maml:name> <maml:description> <maml:para>Used to select the extent to which the service instance is impacted.</maml:para> </maml:description> <command:parameterValue required="false">RequestImpact</command:parameterValue> <dev:type> <maml:name>RequestImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>InternalNote</maml:name> <maml:description> <maml:para>Used to provide information that is visible only for people who have the Auditor, Specialist or Account Administrator role of the account for which the internal note is intended. The x-xurrent-account header sent determines the account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>InternalNoteAttachments</maml:name> <maml:description> <maml:para>The attachments used in the internalNote field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>KnowledgeArticleIds</maml:name> <maml:description> <maml:para>Knowledge articles applied to the request.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>MajorIncidentStatus</maml:name> <maml:description> <maml:para>Used to indicate the status in the major incident management process.</maml:para> </maml:description> <command:parameterValue required="false">RequestMajorIncidentStatus</command:parameterValue> <dev:type> <maml:name>RequestMajorIncidentStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>ID of the person to whom the request is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>NewTags</maml:name> <maml:description> <maml:para>Tags to be added to the request.</maml:para> </maml:description> <command:parameterValue required="false">TagInput[]</command:parameterValue> <dev:type> <maml:name>TagInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>NewWatches</maml:name> <maml:description> <maml:para>New or updated watches.</maml:para> </maml:description> <command:parameterValue required="false">WatchInput[]</command:parameterValue> <dev:type> <maml:name>WatchInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Note</maml:name> <maml:description> <maml:para>Any additional information that could prove useful for resolving the request and/or to provide a summary of the actions that have been taken since the last entry.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>The attachments used in the note field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>ProblemId</maml:name> <maml:description> <maml:para>ID of problem to link request to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>ProductBacklogEstimate</maml:name> <maml:description> <maml:para>Estimate of the relative size of this item on the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>ProductBacklogId</maml:name> <maml:description> <maml:para>Identifier of the product backlog this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>ProductBacklogPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item on the backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>ID of project to link request to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>ProviderNotAccountable</maml:name> <maml:description> <maml:para>Default: false - Whether the provider currently indicates not to be accountable.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>RequestedById</maml:name> <maml:description> <maml:para>ID of the person who submitted the request. Defaults to the Requested for field if its value was explicitely provided, otherwise it defaults to the current authenticated person</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>RequestedForId</maml:name> <maml:description> <maml:para>ID of the person for whom the request was submitted. The person selected in the Requested by field is automatically selected in this field, but another person can be selected if the request is submitted for another person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Reviewed</maml:name> <maml:description> <maml:para>Default: false - A request can be marked as reviewed by the problem manager of the service of the service instance that is linked to the request. Marking a request as reviewed excludes it from the 'Requests for Problem Identification' view.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>ID of the service instance in which the cause of the incident resides, for which the change is requested, or about which information is needed.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Status</maml:name> <maml:description> <maml:para>Default: assigned - Used to select the current status of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestStatus</command:parameterValue> <dev:type> <maml:name>RequestStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>ID of the supplier organization that has been asked to assist with the request. The supplier organization is automatically selected in this field after a service instance has been selected that is provided by an external service provider organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request has been registered at the supplier organization. If the supplier provided a link to the request, enter the entire URL in this field.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>TagsToDelete</maml:name> <maml:description> <maml:para>Identifiers of tags to delete.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>ID of the team to which the request is to be assigned. By default, the first line team of the service instance that is related to the request will be selected. If a first line team has not been specified for the service instance, the support team of the service instance will be selected instead.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>ID of the request template to apply to the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="46"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Setting to true marks request as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="47"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the request is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="48"> <maml:name>WatchesToDelete</maml:name> <maml:description> <maml:para>Identifiers of watches to delete.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="49"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>ID of workflow to link request to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="50"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of request properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RequestField[]</command:parameterValue> <dev:type> <maml:name>RequestField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="51"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Addressed</maml:name> <maml:description> <maml:para>Default: false - When the Satisfaction field of the request is set to 'Dissatisfied', a person who has the Service Desk Manager role, can check the Addressed box to indicate that the requester has been conciliated.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Category</maml:name> <maml:description> <maml:para>The Category field is used to select the category of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestCategory</command:parameterValue> <dev:type> <maml:name>RequestCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>The appropriate completion reason for the request when it has been completed.</maml:para> </maml:description> <command:parameterValue required="false">RequestCompletionReason</command:parameterValue> <dev:type> <maml:name>RequestCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items to relate to the request. When this field is used to update an existing request, all configuration items that were linked to this request will be replaced by the supplied configuration items.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>DesiredCompletionAt</maml:name> <maml:description> <maml:para>The date and time that has been agreed on for the completion of the request. The desired completion overwrites the automatically calculated resolution target of any affected SLA that is related to the request when the desired completion is later than the affected SLA's resolution target. By default, the person selected in the Requested by field receives a notification based on the 'Desired Completion Set for Request' email template whenever the value in the Desired completion field is set, updated or removed.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>DowntimeEndAt</maml:name> <maml:description> <maml:para>Used to specify the actual date and time at which the service became available again.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>DowntimeStartAt</maml:name> <maml:description> <maml:para>Used to specify the actual date and time at which the service outage started.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>GroupedIntoId</maml:name> <maml:description> <maml:para>ID of the request group that is used to group the requests that have been submitted for the resolution of exactly the same incident, for the implementation of exactly the same change, for the provision of exactly the same information, etc.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Impact</maml:name> <maml:description> <maml:para>Used to select the extent to which the service instance is impacted.</maml:para> </maml:description> <command:parameterValue required="false">RequestImpact</command:parameterValue> <dev:type> <maml:name>RequestImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>InternalNote</maml:name> <maml:description> <maml:para>Used to provide information that is visible only for people who have the Auditor, Specialist or Account Administrator role of the account for which the internal note is intended. The x-xurrent-account header sent determines the account.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>InternalNoteAttachments</maml:name> <maml:description> <maml:para>The attachments used in the internalNote field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>KnowledgeArticleIds</maml:name> <maml:description> <maml:para>Knowledge articles applied to the request.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>MajorIncidentStatus</maml:name> <maml:description> <maml:para>Used to indicate the status in the major incident management process.</maml:para> </maml:description> <command:parameterValue required="false">RequestMajorIncidentStatus</command:parameterValue> <dev:type> <maml:name>RequestMajorIncidentStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>ID of the person to whom the request is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>NewTags</maml:name> <maml:description> <maml:para>Tags to be added to the request.</maml:para> </maml:description> <command:parameterValue required="false">TagInput[]</command:parameterValue> <dev:type> <maml:name>TagInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>NewWatches</maml:name> <maml:description> <maml:para>New or updated watches.</maml:para> </maml:description> <command:parameterValue required="false">WatchInput[]</command:parameterValue> <dev:type> <maml:name>WatchInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Note</maml:name> <maml:description> <maml:para>Any additional information that could prove useful for resolving the request and/or to provide a summary of the actions that have been taken since the last entry.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>The attachments used in the note field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>ProblemId</maml:name> <maml:description> <maml:para>ID of problem to link request to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>ProductBacklogEstimate</maml:name> <maml:description> <maml:para>Estimate of the relative size of this item on the product backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>ProductBacklogId</maml:name> <maml:description> <maml:para>Identifier of the product backlog this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>ProductBacklogPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item on the backlog.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>ID of project to link request to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>ProviderNotAccountable</maml:name> <maml:description> <maml:para>Default: false - Whether the provider currently indicates not to be accountable.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>RequestedById</maml:name> <maml:description> <maml:para>ID of the person who submitted the request. Defaults to the Requested for field if its value was explicitely provided, otherwise it defaults to the current authenticated person</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>RequestedForId</maml:name> <maml:description> <maml:para>ID of the person for whom the request was submitted. The person selected in the Requested by field is automatically selected in this field, but another person can be selected if the request is submitted for another person.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Reviewed</maml:name> <maml:description> <maml:para>Default: false - A request can be marked as reviewed by the problem manager of the service of the service instance that is linked to the request. Marking a request as reviewed excludes it from the 'Requests for Problem Identification' view.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>ID of the service instance in which the cause of the incident resides, for which the change is requested, or about which information is needed.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Status</maml:name> <maml:description> <maml:para>Default: assigned - Used to select the current status of the request.</maml:para> </maml:description> <command:parameterValue required="false">RequestStatus</command:parameterValue> <dev:type> <maml:name>RequestStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>ID of the supplier organization that has been asked to assist with the request. The supplier organization is automatically selected in this field after a service instance has been selected that is provided by an external service provider organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request has been registered at the supplier organization. If the supplier provided a link to the request, enter the entire URL in this field.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>TagsToDelete</maml:name> <maml:description> <maml:para>Identifiers of tags to delete.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>ID of the team to which the request is to be assigned. By default, the first line team of the service instance that is related to the request will be selected. If a first line team has not been specified for the service instance, the support team of the service instance will be selected instead.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>ID of the request template to apply to the request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="46"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Setting to true marks request as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="47"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the request is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="48"> <maml:name>WatchesToDelete</maml:name> <maml:description> <maml:para>Identifiers of watches to delete.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="49"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>ID of workflow to link request to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="50"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of request properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RequestField[]</command:parameterValue> <dev:type> <maml:name>RequestField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="51"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestCategory</maml:name> </dev:type> <maml:description> <maml:para>A request category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestCompletionReason</maml:name> </dev:type> <maml:description> <maml:para>A request completion reason object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestImpact</maml:name> </dev:type> <maml:description> <maml:para>A request impact object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestMajorIncidentStatus</maml:name> </dev:type> <maml:description> <maml:para>A request major incident status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TagInput[]</maml:name> </dev:type> <maml:description> <maml:para>A tag input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WatchInput[]</maml:name> </dev:type> <maml:description> <maml:para>A watch input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestStatus</maml:name> </dev:type> <maml:description> <maml:para>A request status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestField[]</maml:name> </dev:type> <maml:description> <maml:para>The request field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Request</maml:name> </dev:type> <maml:description> <maml:para>A request object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentRequestTemplate</command:name> <command:verb>Set</command:verb> <command:noun>XurrentRequestTemplate</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a request template.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a request template using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentRequestTemplate</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AssetSelection</maml:name> <maml:description> <maml:para>After selecting the request template in Self Service, the user needs to be able to select a configuration item in the Asset field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AssignToSelf</maml:name> <maml:description> <maml:para>Whether the person who is registering a new request based on the template is selected in its Member field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestCategory</command:parameterValue> <dev:type> <maml:name>RequestCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>The completion reason that needs to be selected in the Completion reason field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestCompletionReason</command:parameterValue> <dev:type> <maml:name>RequestCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ConfigurationItemId</maml:name> <maml:description> <maml:para>Identifier of the CI that needs to be copied to the Configuration item field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CopySubjectToRequests</maml:name> <maml:description> <maml:para>Whether the subject of the request template needs to become the subject of a request when the template is applied, provided that the Subject field of this request is empty.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DesiredCompletion</maml:name> <maml:description> <maml:para>Used to enter the number of minutes within which requests that are based on the request template are to be resolved.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the request template may not be used to help register new requests.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a request that is based on the request template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>EndUsers</maml:name> <maml:description> <maml:para>Whether the request template is shown to end users in Self Service.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Impact</maml:name> <maml:description> <maml:para>The impact level that needs to be selected in the Impact field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestImpact</command:parameterValue> <dev:type> <maml:name>RequestImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Instructions for the support staff who will work on requests that are based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Keywords</maml:name> <maml:description> <maml:para>A comma-separated list of words that can be used to find the request template using search.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person who should be selected in the Member field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>RegistrationHints</maml:name> <maml:description> <maml:para>The information that needs to be displayed after the template has been applied to a new or existing request. This field typically contains step-by-step instructions about how to complete the registration of a request that is based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ReservationOfferingIds</maml:name> <maml:description> <maml:para>Identifiers of reservation offerings related to the request template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the request template is made available.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Specialists</maml:name> <maml:description> <maml:para>Whether the request template is shown to Specialists.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Status</maml:name> <maml:description> <maml:para>Used to select the status value that needs to be selected in the Status field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestStatus</command:parameterValue> <dev:type> <maml:name>RequestStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that should be selected in the Supplier field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>SupportHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that is to be used to calculate the desired completion for requests that are based on the request template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team that should be selected in the Team field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected support hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether a new request that is created based on the template is to be marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>Identifier of the Workflow Manager linked to the request template. Required when a Workflow Template is defined, and the Service does not define a Workflow Manager.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>WorkflowTemplateId</maml:name> <maml:description> <maml:para>Identifier of the Workflow Template related to the request template. Required when the Status is set to _Workflow Pending_.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="33"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of request template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RequestTemplateField[]</command:parameterValue> <dev:type> <maml:name>RequestTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AssetSelection</maml:name> <maml:description> <maml:para>After selecting the request template in Self Service, the user needs to be able to select a configuration item in the Asset field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AssignToSelf</maml:name> <maml:description> <maml:para>Whether the person who is registering a new request based on the template is selected in its Member field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestCategory</command:parameterValue> <dev:type> <maml:name>RequestCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>The completion reason that needs to be selected in the Completion reason field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestCompletionReason</command:parameterValue> <dev:type> <maml:name>RequestCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ConfigurationItemId</maml:name> <maml:description> <maml:para>Identifier of the CI that needs to be copied to the Configuration item field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CopySubjectToRequests</maml:name> <maml:description> <maml:para>Whether the subject of the request template needs to become the subject of a request when the template is applied, provided that the Subject field of this request is empty.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>DesiredCompletion</maml:name> <maml:description> <maml:para>Used to enter the number of minutes within which requests that are based on the request template are to be resolved.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the request template may not be used to help register new requests.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a request that is based on the request template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>EndUsers</maml:name> <maml:description> <maml:para>Whether the request template is shown to end users in Self Service.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Impact</maml:name> <maml:description> <maml:para>The impact level that needs to be selected in the Impact field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestImpact</command:parameterValue> <dev:type> <maml:name>RequestImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Instructions for the support staff who will work on requests that are based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Keywords</maml:name> <maml:description> <maml:para>A comma-separated list of words that can be used to find the request template using search.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person who should be selected in the Member field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>RegistrationHints</maml:name> <maml:description> <maml:para>The information that needs to be displayed after the template has been applied to a new or existing request. This field typically contains step-by-step instructions about how to complete the registration of a request that is based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ReservationOfferingIds</maml:name> <maml:description> <maml:para>Identifiers of reservation offerings related to the request template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the request template is made available.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Specialists</maml:name> <maml:description> <maml:para>Whether the request template is shown to Specialists.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Status</maml:name> <maml:description> <maml:para>Used to select the status value that needs to be selected in the Status field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">RequestStatus</command:parameterValue> <dev:type> <maml:name>RequestStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that should be selected in the Supplier field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>SupportHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that is to be used to calculate the desired completion for requests that are based on the request template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team that should be selected in the Team field of a new request when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected support hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether a new request that is created based on the template is to be marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>Identifier of the Workflow Manager linked to the request template. Required when a Workflow Template is defined, and the Service does not define a Workflow Manager.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>WorkflowTemplateId</maml:name> <maml:description> <maml:para>Identifier of the Workflow Template related to the request template. Required when the Status is set to _Workflow Pending_.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="33"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of request template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RequestTemplateField[]</command:parameterValue> <dev:type> <maml:name>RequestTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestCategory</maml:name> </dev:type> <maml:description> <maml:para>A request category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestCompletionReason</maml:name> </dev:type> <maml:description> <maml:para>A request completion reason object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestImpact</maml:name> </dev:type> <maml:description> <maml:para>A request impact object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestStatus</maml:name> </dev:type> <maml:description> <maml:para>A request status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RequestTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The request template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RequestTemplate</maml:name> </dev:type> <maml:description> <maml:para>A request template object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentReservation</command:name> <command:verb>Set</command:verb> <command:noun>XurrentReservation</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a reservation.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a reservation using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentReservation</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ConfigurationItemId</maml:name> <maml:description> <maml:para>Identifier of the asset that is being reserved.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CreatedById</maml:name> <maml:description> <maml:para>Identifier of the person who created this reservation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Full description of the reservation</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Duration</maml:name> <maml:description> <maml:para>The duration of the reservation during the calendar hours of the reservation offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>Used to specify the end date and time of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>A short description of the reservation</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person for whom this reservation was created.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PreparationStartAt</maml:name> <maml:description> <maml:para>The start date and time of the preparation of the asset for the reservation. Only present in case the reservation offering specifies a preparation duration.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for the reservation.</maml:para> </maml:description> <command:parameterValue required="false">ReservationRecurrenceInput</command:parameterValue> <dev:type> <maml:name>ReservationRecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Identifier of the request for reservation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ReservationOfferingId</maml:name> <maml:description> <maml:para>Identifier of the reservation offering that was used to create this reservation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Used to specify the start date and time of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">ReservationStatus</command:parameterValue> <dev:type> <maml:name>ReservationStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="18"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of reservation properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReservationField[]</command:parameterValue> <dev:type> <maml:name>ReservationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ConfigurationItemId</maml:name> <maml:description> <maml:para>Identifier of the asset that is being reserved.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CreatedById</maml:name> <maml:description> <maml:para>Identifier of the person who created this reservation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Full description of the reservation</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Duration</maml:name> <maml:description> <maml:para>The duration of the reservation during the calendar hours of the reservation offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>Used to specify the end date and time of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>A short description of the reservation</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person for whom this reservation was created.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PreparationStartAt</maml:name> <maml:description> <maml:para>The start date and time of the preparation of the asset for the reservation. Only present in case the reservation offering specifies a preparation duration.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for the reservation.</maml:para> </maml:description> <command:parameterValue required="false">ReservationRecurrenceInput</command:parameterValue> <dev:type> <maml:name>ReservationRecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Identifier of the request for reservation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ReservationOfferingId</maml:name> <maml:description> <maml:para>Identifier of the reservation offering that was used to create this reservation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Used to specify the start date and time of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">ReservationStatus</command:parameterValue> <dev:type> <maml:name>ReservationStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="18"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of reservation properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReservationField[]</command:parameterValue> <dev:type> <maml:name>ReservationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationRecurrenceInput</maml:name> </dev:type> <maml:description> <maml:para>A reservation recurrence input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationStatus</maml:name> </dev:type> <maml:description> <maml:para>A reservation status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationField[]</maml:name> </dev:type> <maml:description> <maml:para>The reservation field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Reservation</maml:name> </dev:type> <maml:description> <maml:para>A reservation object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentReservationOffering</command:name> <command:verb>Set</command:verb> <command:noun>XurrentReservationOffering</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a reservation offering.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a reservation offering using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentReservationOffering</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AllowRepeat</maml:name> <maml:description> <maml:para>Whether it is allowed to create recurrent reservations for this offering.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CalendarId</maml:name> <maml:description> <maml:para>Calendar that defines the hours in which reservations may start and end.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items that may be reserved using this offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the reservation offering may not be used to register requests for reservation.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Filters</maml:name> <maml:description> <maml:para>The filters of the reservation offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>InitialStatus</maml:name> <maml:description> <maml:para>The initial status of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">ReservationStatus</command:parameterValue> <dev:type> <maml:name>ReservationStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaxAdvanceDuration</maml:name> <maml:description> <maml:para>The maximum duration between the creation time of a request for reservation and the requested start of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>MaxDuration</maml:name> <maml:description> <maml:para>The maximum duration of the reservation within the hours of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>MinAdvanceDuration</maml:name> <maml:description> <maml:para>The minimum duration between the creation time of a request for reservation and the requested start of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>MinDuration</maml:name> <maml:description> <maml:para>The minimum duration of the reservation within the hours of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>MultiDay</maml:name> <maml:description> <maml:para>Whether or not the reservation may span over multiple calendar days.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Name</maml:name> <maml:description> <maml:para>A short description of the reservation offering</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PreparationDuration</maml:name> <maml:description> <maml:para>The duration required to prepare the asset before the reservation starts.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PrivateReservations</maml:name> <maml:description> <maml:para>Reservations of this reservation offering are private and can not be viewed by other end users.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the service instance for which the reservations may be requested.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>StepDuration</maml:name> <maml:description> <maml:para>The increments with which the reservation may be prolonged.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected calendar.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="21"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of reservation offering properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReservationOfferingField[]</command:parameterValue> <dev:type> <maml:name>ReservationOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AllowRepeat</maml:name> <maml:description> <maml:para>Whether it is allowed to create recurrent reservations for this offering.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CalendarId</maml:name> <maml:description> <maml:para>Calendar that defines the hours in which reservations may start and end.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items that may be reserved using this offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the reservation offering may not be used to register requests for reservation.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Filters</maml:name> <maml:description> <maml:para>The filters of the reservation offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>InitialStatus</maml:name> <maml:description> <maml:para>The initial status of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">ReservationStatus</command:parameterValue> <dev:type> <maml:name>ReservationStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaxAdvanceDuration</maml:name> <maml:description> <maml:para>The maximum duration between the creation time of a request for reservation and the requested start of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>MaxDuration</maml:name> <maml:description> <maml:para>The maximum duration of the reservation within the hours of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>MinAdvanceDuration</maml:name> <maml:description> <maml:para>The minimum duration between the creation time of a request for reservation and the requested start of the reservation.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>MinDuration</maml:name> <maml:description> <maml:para>The minimum duration of the reservation within the hours of the calendar.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>MultiDay</maml:name> <maml:description> <maml:para>Whether or not the reservation may span over multiple calendar days.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Name</maml:name> <maml:description> <maml:para>A short description of the reservation offering</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PreparationDuration</maml:name> <maml:description> <maml:para>The duration required to prepare the asset before the reservation starts.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PrivateReservations</maml:name> <maml:description> <maml:para>Reservations of this reservation offering are private and can not be viewed by other end users.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the service instance for which the reservations may be requested.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>StepDuration</maml:name> <maml:description> <maml:para>The increments with which the reservation may be prolonged.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected calendar.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="21"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of reservation offering properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ReservationOfferingField[]</command:parameterValue> <dev:type> <maml:name>ReservationOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationStatus</maml:name> </dev:type> <maml:description> <maml:para>A reservation status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ReservationOfferingField[]</maml:name> </dev:type> <maml:description> <maml:para>The reservation offering field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ReservationOffering</maml:name> </dev:type> <maml:description> <maml:para>A reservation offering object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentRisk</command:name> <command:verb>Set</command:verb> <command:noun>XurrentRisk</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a risk.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a risk using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentRisk</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClosureReason</maml:name> <maml:description> <maml:para>The appropriate closure reason for the risk when it has been closed.</maml:para> </maml:description> <command:parameterValue required="false">RiskClosureReason</command:parameterValue> <dev:type> <maml:name>RiskClosureReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the manager of the risk. This person is able to maintain the information about the risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MitigationTargetAt</maml:name> <maml:description> <maml:para>The date by which the risk should have been mitigated.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Note</maml:name> <maml:description> <maml:para>The Note field is used to provide a detailed description of the risk and the actions that are planned or have already been taken to eliminate it, or to minimize its severity. This field is also used when the status is set to closed to explain why it was decided to close the risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of organizations linked to the risk.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ProjectIds</maml:name> <maml:description> <maml:para>Identifiers of projects linked to the risk.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServiceIds</maml:name> <maml:description> <maml:para>Identifiers of services linked to the risk.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Severity</maml:name> <maml:description> <maml:para>The severity of the risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the risk.</maml:para> </maml:description> <command:parameterValue required="false">RiskStatus</command:parameterValue> <dev:type> <maml:name>RiskStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Subject</maml:name> <maml:description> <maml:para>The subject of the risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="17"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of risk properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RiskField[]</command:parameterValue> <dev:type> <maml:name>RiskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClosureReason</maml:name> <maml:description> <maml:para>The appropriate closure reason for the risk when it has been closed.</maml:para> </maml:description> <command:parameterValue required="false">RiskClosureReason</command:parameterValue> <dev:type> <maml:name>RiskClosureReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Identifier of the manager of the risk. This person is able to maintain the information about the risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MitigationTargetAt</maml:name> <maml:description> <maml:para>The date by which the risk should have been mitigated.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Note</maml:name> <maml:description> <maml:para>The Note field is used to provide a detailed description of the risk and the actions that are planned or have already been taken to eliminate it, or to minimize its severity. This field is also used when the status is set to closed to explain why it was decided to close the risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of organizations linked to the risk.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ProjectIds</maml:name> <maml:description> <maml:para>Identifiers of projects linked to the risk.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServiceIds</maml:name> <maml:description> <maml:para>Identifiers of services linked to the risk.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Severity</maml:name> <maml:description> <maml:para>The severity of the risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the risk.</maml:para> </maml:description> <command:parameterValue required="false">RiskStatus</command:parameterValue> <dev:type> <maml:name>RiskStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Subject</maml:name> <maml:description> <maml:para>The subject of the risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="17"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of risk properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RiskField[]</command:parameterValue> <dev:type> <maml:name>RiskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskClosureReason</maml:name> </dev:type> <maml:description> <maml:para>A risk closure reason object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskStatus</maml:name> </dev:type> <maml:description> <maml:para>A risk status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskField[]</maml:name> </dev:type> <maml:description> <maml:para>The risk field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Risk</maml:name> </dev:type> <maml:description> <maml:para>A risk object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentRiskSeverity</command:name> <command:verb>Set</command:verb> <command:noun>XurrentRiskSeverity</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a risk severity.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a risk severity using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentRiskSeverity</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A very short description of the risk severity, for example "Risk is Significant".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the risk severity may not be related to any more risks.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the risk severity that might prove useful, especially for risk managers when they need to decide which severity to select for a risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the risk severity. Ideally the name of a risk severity consists of a single word, such as "High".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the risk severity takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of risk severity properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RiskSeverityField[]</command:parameterValue> <dev:type> <maml:name>RiskSeverityField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A very short description of the risk severity, for example "Risk is Significant".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the risk severity may not be related to any more risks.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the risk severity that might prove useful, especially for risk managers when they need to decide which severity to select for a risk.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the risk severity. Ideally the name of a risk severity consists of a single word, such as "High".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the risk severity takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of risk severity properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RiskSeverityField[]</command:parameterValue> <dev:type> <maml:name>RiskSeverityField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RiskSeverityField[]</maml:name> </dev:type> <maml:description> <maml:para>The risk severity field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RiskSeverity</maml:name> </dev:type> <maml:description> <maml:para>A risk severity object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentScrumWorkspace</command:name> <command:verb>Set</command:verb> <command:noun>XurrentScrumWorkspace</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a scrum workspace.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a scrum workspace using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentScrumWorkspace</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>Identifier of the agile board used to track the progress of this workspace's active sprint.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Additional information regarding the scrum workspace.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the scrum workspace is in use.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the scrum workspace.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ProductBacklogId</maml:name> <maml:description> <maml:para>Identifier of the product backlog used when planning sprints.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SprintLength</maml:name> <maml:description> <maml:para>Standard length in weeks of new sprints planned in this scrum workspace.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team planning their work using this scrum workspace.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of scrum workspace properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ScrumWorkspaceField[]</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>Identifier of the agile board used to track the progress of this workspace's active sprint.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Additional information regarding the scrum workspace.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the scrum workspace is in use.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the scrum workspace.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ProductBacklogId</maml:name> <maml:description> <maml:para>Identifier of the product backlog used when planning sprints.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SprintLength</maml:name> <maml:description> <maml:para>Standard length in weeks of new sprints planned in this scrum workspace.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team planning their work using this scrum workspace.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of scrum workspace properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ScrumWorkspaceField[]</command:parameterValue> <dev:type> <maml:name>ScrumWorkspaceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ScrumWorkspaceField[]</maml:name> </dev:type> <maml:description> <maml:para>The scrum workspace field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ScrumWorkspace</maml:name> </dev:type> <maml:description> <maml:para>A scrum workspace object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentService</command:name> <command:verb>Set</command:verb> <command:noun>XurrentService</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a service.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a service using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentService</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AvailabilityManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for ensuring that the availability targets specified in the active SLAs for the service are met.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CapacityManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for ensuring that the service is not affected by incidents that are caused by capacity shortages.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ChangeManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the changes of the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ContinuityManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for creating and maintaining the continuity plans for the service's instances that have an active SLA with a continuity target.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the service's core functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the service may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FirstLineTeamId</maml:name> <maml:description> <maml:para>Identifier of the team that will, by default, be selected in the First line team field of a new service instance when it is being registered for the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Keywords</maml:name> <maml:description> <maml:para>A comma-separated list of words that can be used to find the service via search.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>KnowledgeManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for the quality of the knowledge articles for the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service. The service name may be followed by the name of its core application placed between brackets.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProblemManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the problems that directly affect the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ProviderId</maml:name> <maml:description> <maml:para>Identifier of the organization who provides the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ReleaseManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the releases of the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceOwnerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for ensuring that the service level targets specified in the SLAs for the service are met.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team that will, by default, be selected in the Support team field of a service instance when one is registered for the service. Similarly, this team will be selected in the Team field of a problem when the service is related to it.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>SurveyId</maml:name> <maml:description> <maml:para>Identifier of the survey used to measure customer rating of this service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="25"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceField[]</command:parameterValue> <dev:type> <maml:name>ServiceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AvailabilityManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for ensuring that the availability targets specified in the active SLAs for the service are met.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CapacityManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for ensuring that the service is not affected by incidents that are caused by capacity shortages.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ChangeManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the changes of the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ContinuityManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for creating and maintaining the continuity plans for the service's instances that have an active SLA with a continuity target.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the service's core functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the service may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FirstLineTeamId</maml:name> <maml:description> <maml:para>Identifier of the team that will, by default, be selected in the First line team field of a new service instance when it is being registered for the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Keywords</maml:name> <maml:description> <maml:para>A comma-separated list of words that can be used to find the service via search.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>KnowledgeManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for the quality of the knowledge articles for the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service. The service name may be followed by the name of its core application placed between brackets.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ProblemManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the problems that directly affect the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ProviderId</maml:name> <maml:description> <maml:para>Identifier of the organization who provides the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ReleaseManagerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for coordinating the releases of the service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceOwnerId</maml:name> <maml:description> <maml:para>Identifier of the person who is responsible for ensuring that the service level targets specified in the SLAs for the service are met.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team that will, by default, be selected in the Support team field of a service instance when one is registered for the service. Similarly, this team will be selected in the Team field of a problem when the service is related to it.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>SurveyId</maml:name> <maml:description> <maml:para>Identifier of the survey used to measure customer rating of this service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="25"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceField[]</command:parameterValue> <dev:type> <maml:name>ServiceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceField[]</maml:name> </dev:type> <maml:description> <maml:para>The service field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Service</maml:name> </dev:type> <maml:description> <maml:para>A service object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentServiceCategory</command:name> <command:verb>Set</command:verb> <command:noun>XurrentServiceCategory</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a service category.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a service category using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentServiceCategory</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the type of services that are included in the service category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ServiceIds</maml:name> <maml:description> <maml:para>Identifiers of the services of the service category.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceCategoryField[]</command:parameterValue> <dev:type> <maml:name>ServiceCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>A high-level description of the type of services that are included in the service category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ServiceIds</maml:name> <maml:description> <maml:para>Identifiers of the services of the service category.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceCategoryField[]</command:parameterValue> <dev:type> <maml:name>ServiceCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceCategoryField[]</maml:name> </dev:type> <maml:description> <maml:para>The service category field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceCategory</maml:name> </dev:type> <maml:description> <maml:para>A service category object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentServiceInstance</command:name> <command:verb>Set</command:verb> <command:noun>XurrentServiceInstance</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a service instance.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a service instance using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentServiceInstance</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the service instance.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>FirstLineTeamId</maml:name> <maml:description> <maml:para>Idenifier of the team that will automatically be selected in the Team field of requests to which the service instance is linked after they have been submitted using Self Service or when they are generated using the Requests API, Mail API or Events API.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service instance.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the service instance that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service which functionality the service instance provides.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the service instance.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceStatus</command:parameterValue> <dev:type> <maml:name>ServiceInstanceStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team that will, by default, be selected in the Team field of a request when the service instance is manually selected in the Service instance field of the request, or when the service instance is applied from the Service Hierarchy Browser.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="16"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service instance properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceInstanceField[]</command:parameterValue> <dev:type> <maml:name>ServiceInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the service instance.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>FirstLineTeamId</maml:name> <maml:description> <maml:para>Idenifier of the team that will automatically be selected in the Team field of requests to which the service instance is linked after they have been submitted using Self Service or when they are generated using the Requests API, Mail API or Events API.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service instance.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the service instance that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service which functionality the service instance provides.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the service instance.</maml:para> </maml:description> <command:parameterValue required="false">ServiceInstanceStatus</command:parameterValue> <dev:type> <maml:name>ServiceInstanceStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SupportTeamId</maml:name> <maml:description> <maml:para>Identifier of the team that will, by default, be selected in the Team field of a request when the service instance is manually selected in the Service instance field of the request, or when the service instance is applied from the Service Hierarchy Browser.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="16"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service instance properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceInstanceField[]</command:parameterValue> <dev:type> <maml:name>ServiceInstanceField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceStatus</maml:name> </dev:type> <maml:description> <maml:para>A service instance status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceInstanceField[]</maml:name> </dev:type> <maml:description> <maml:para>The service instance field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceInstance</maml:name> </dev:type> <maml:description> <maml:para>A service instance object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentServiceLevelAgreement</command:name> <command:verb>Set</command:verb> <command:noun>XurrentServiceLevelAgreement</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a service level agreement.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a service level agreement using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentServiceLevelAgreement</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ActivityID</maml:name> <maml:description> <maml:para>The Activity ID is the unique identifier by which an activity that is performed in the context of a service offering is known in the billing system of the service provider. This contains the activityIDs related to request categories.</maml:para> </maml:description> <command:parameterValue required="false">ActivityIDInput</command:parameterValue> <dev:type> <maml:name>ActivityIDInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgreementID</maml:name> <maml:description> <maml:para>The Agreement ID is the unique identifier by which all the activities that are performed through the coverage of the SLA are known in the billing system of the service provider.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Coverage</maml:name> <maml:description> <maml:para>Used to specify how people who are to be covered by the service level agreement are to be selected.</maml:para> </maml:description> <command:parameterValue required="false">SlaCoverage</command:parameterValue> <dev:type> <maml:name>SlaCoverage</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization that pays for the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomerRepresentativeIds</maml:name> <maml:description> <maml:para>Identifiers of the people who represents the customer organization for the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClassRateIDsToDelete</maml:name> <maml:description> <maml:para>Identifiers of effort class rateIDs to remove from the SLA.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ExpiryDate</maml:name> <maml:description> <maml:para>The date through which the service level agreement (SLA) will be active. The SLA expires at the end of this day if it is not renewed before then. When the SLA has expired, its status will automatically be set to "Expired".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>NewEffortClassRateIDs</maml:name> <maml:description> <maml:para>The Rate IDs are the unique identifiers by which an effort class that is linked to a time entry when an activity was performed through the coverage of the SLA is known in the billing system of the service provider.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassRateIDInput[]</command:parameterValue> <dev:type> <maml:name>EffortClassRateIDInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>NewStandardServiceRequestActivityIDs</maml:name> <maml:description> <maml:para>Represents the activityIDs for standard service requests. The Activity ID is the unique identifier by which an activity that is performed in the context of a service offering is known in the billing system of the service provider</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestActivityIDInput[]</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestActivityIDInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>NoticeDate</maml:name> <maml:description> <maml:para>The last day on which the service provider organization can still be contacted to terminate the service level agreement (SLA) to ensure that it expires on the intended expiry date. The Notice date field is left empty, and the Expiry date field is filled out, when the SLA is to expire on a specific date and no notice needs to be given to terminate it.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of the organizations of the service level agreement. Only available for service level agreements where the coverage field is set to organizations_and_descendants, organizations or organizations_and_sites.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PersonIds</maml:name> <maml:description> <maml:para>Identifiers of the people of the service level agreement. Only available for service level agreements where the coverage field is set to people.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the service level agreement that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the service instance that will be used to provide the service to the customer of the service level agreement. Only service instances that are linked to the same service as the selected service offering can be selected.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceLevelManagerId</maml:name> <maml:description> <maml:para>Identifier of the person of the service provider organization who acts as the service level manager for the customer of the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceOfferingId</maml:name> <maml:description> <maml:para>Identifier of the service offering that specifies the conditions that apply to the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SiteIds</maml:name> <maml:description> <maml:para>Identifiers of the sites of the service level agreement. Only available for service level agreements where the coverage field is set to sites or organizations_and_sites.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>Identifiers of the skill pools of the service level agreement. Only available for service level agreements where the coverage field is set to skill_pools.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>StandardServiceRequestActivityIDsToDelete</maml:name> <maml:description> <maml:para>Identifiers of effort class rateIDs to remove from the SLA.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The first day during which the service level agreement (SLA) is active.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the service level agreement (SLA).</maml:para> </maml:description> <command:parameterValue required="false">AgreementStatus</command:parameterValue> <dev:type> <maml:name>AgreementStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>UseKnowledgeFromServiceProvider</maml:name> <maml:description> <maml:para>Whether knowledge articles from the service provider should be exposed to the people covered by the service instances related to the service level agreement. Only available for service level agreements where the coverage field is set to service_instances.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="28"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service level agreement properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceLevelAgreementField[]</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ActivityID</maml:name> <maml:description> <maml:para>The Activity ID is the unique identifier by which an activity that is performed in the context of a service offering is known in the billing system of the service provider. This contains the activityIDs related to request categories.</maml:para> </maml:description> <command:parameterValue required="false">ActivityIDInput</command:parameterValue> <dev:type> <maml:name>ActivityIDInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgreementID</maml:name> <maml:description> <maml:para>The Agreement ID is the unique identifier by which all the activities that are performed through the coverage of the SLA are known in the billing system of the service provider.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Coverage</maml:name> <maml:description> <maml:para>Used to specify how people who are to be covered by the service level agreement are to be selected.</maml:para> </maml:description> <command:parameterValue required="false">SlaCoverage</command:parameterValue> <dev:type> <maml:name>SlaCoverage</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization that pays for the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomerRepresentativeIds</maml:name> <maml:description> <maml:para>Identifiers of the people who represents the customer organization for the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClassRateIDsToDelete</maml:name> <maml:description> <maml:para>Identifiers of effort class rateIDs to remove from the SLA.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ExpiryDate</maml:name> <maml:description> <maml:para>The date through which the service level agreement (SLA) will be active. The SLA expires at the end of this day if it is not renewed before then. When the SLA has expired, its status will automatically be set to "Expired".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>NewEffortClassRateIDs</maml:name> <maml:description> <maml:para>The Rate IDs are the unique identifiers by which an effort class that is linked to a time entry when an activity was performed through the coverage of the SLA is known in the billing system of the service provider.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassRateIDInput[]</command:parameterValue> <dev:type> <maml:name>EffortClassRateIDInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>NewStandardServiceRequestActivityIDs</maml:name> <maml:description> <maml:para>Represents the activityIDs for standard service requests. The Activity ID is the unique identifier by which an activity that is performed in the context of a service offering is known in the billing system of the service provider</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestActivityIDInput[]</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestActivityIDInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>NoticeDate</maml:name> <maml:description> <maml:para>The last day on which the service provider organization can still be contacted to terminate the service level agreement (SLA) to ensure that it expires on the intended expiry date. The Notice date field is left empty, and the Expiry date field is filled out, when the SLA is to expire on a specific date and no notice needs to be given to terminate it.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of the organizations of the service level agreement. Only available for service level agreements where the coverage field is set to organizations_and_descendants, organizations or organizations_and_sites.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PersonIds</maml:name> <maml:description> <maml:para>Identifiers of the people of the service level agreement. Only available for service level agreements where the coverage field is set to people.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the service level agreement that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the service instance that will be used to provide the service to the customer of the service level agreement. Only service instances that are linked to the same service as the selected service offering can be selected.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServiceLevelManagerId</maml:name> <maml:description> <maml:para>Identifier of the person of the service provider organization who acts as the service level manager for the customer of the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServiceOfferingId</maml:name> <maml:description> <maml:para>Identifier of the service offering that specifies the conditions that apply to the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>SiteIds</maml:name> <maml:description> <maml:para>Identifiers of the sites of the service level agreement. Only available for service level agreements where the coverage field is set to sites or organizations_and_sites.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SkillPoolIds</maml:name> <maml:description> <maml:para>Identifiers of the skill pools of the service level agreement. Only available for service level agreements where the coverage field is set to skill_pools.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>StandardServiceRequestActivityIDsToDelete</maml:name> <maml:description> <maml:para>Identifiers of effort class rateIDs to remove from the SLA.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The first day during which the service level agreement (SLA) is active.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the service level agreement (SLA).</maml:para> </maml:description> <command:parameterValue required="false">AgreementStatus</command:parameterValue> <dev:type> <maml:name>AgreementStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>UseKnowledgeFromServiceProvider</maml:name> <maml:description> <maml:para>Whether knowledge articles from the service provider should be exposed to the people covered by the service instances related to the service level agreement. Only available for service level agreements where the coverage field is set to service_instances.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="28"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service level agreement properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceLevelAgreementField[]</command:parameterValue> <dev:type> <maml:name>ServiceLevelAgreementField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ActivityIDInput</maml:name> </dev:type> <maml:description> <maml:para>An activity identifier input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaCoverage</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement coverage object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassRateIDInput[]</maml:name> </dev:type> <maml:description> <maml:para>An effort class rate identifier input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.StandardServiceRequestActivityIDInput[]</maml:name> </dev:type> <maml:description> <maml:para>A standard service request activity identifier input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AgreementStatus</maml:name> </dev:type> <maml:description> <maml:para>An agreement status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceLevelAgreementField[]</maml:name> </dev:type> <maml:description> <maml:para>The service level agreement field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceLevelAgreement</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentServiceOffering</command:name> <command:verb>Set</command:verb> <command:noun>XurrentServiceOffering</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a service offering.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a service offering using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentServiceOffering</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Availability</maml:name> <maml:description> <maml:para>The duration, expressed as percentage of the total number of service hours, during which the service is to be available to customers with an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Charges</maml:name> <maml:description> <maml:para>The amount that the service provider will charge the customer for the delivery of the service per charge driver, per charge term.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ChargeTypeCase</maml:name> <maml:description> <maml:para>Defines how a Case must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ChargeTypeHigh</maml:name> <maml:description> <maml:para>Defines how a high incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ChargeTypeLow</maml:name> <maml:description> <maml:para>Defines how a low incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ChargeTypeMedium</maml:name> <maml:description> <maml:para>Defines how a medium incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ChargeTypeRfc</maml:name> <maml:description> <maml:para>Defines how a RFC must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ChargeTypeRfi</maml:name> <maml:description> <maml:para>Defines how a RFI must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ChargeTypeTop</maml:name> <maml:description> <maml:para>Defines how a top incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Continuity</maml:name> <maml:description> <maml:para>The continuity measures for the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>DefaultEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a request with an affected SLA linked to this service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>EffortClassIds</maml:name> <maml:description> <maml:para>Identifiers of effort classes of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>EffortClassRatesToDelete</maml:name> <maml:description> <maml:para>Identifiers of effort class rates to remove from the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Limitations</maml:name> <maml:description> <maml:para>The limitations that apply to the service level agreements that are based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>NewEffortClassRates</maml:name> <maml:description> <maml:para>Effort class rates of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassRateInput[]</command:parameterValue> <dev:type> <maml:name>EffortClassRateInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>NewStandardServiceRequests</maml:name> <maml:description> <maml:para>Standard service requests of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestInput[]</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Penalties</maml:name> <maml:description> <maml:para>Used to specify what the penalties will be for the service provider organization if a service level target has been breached.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Performance</maml:name> <maml:description> <maml:para>Used to describe the transaction(s) and the maximum time these transaction(s) can take to complete.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Prerequisites</maml:name> <maml:description> <maml:para>Used to specify which requirements need to be met by the customer in order for the customer to be able to benefit from the service. The service provider cannot be held accountable for breaches of the service level targets caused by a failure of the customer to meet one or more of these prerequisites.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>RateCase</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a Case.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>RateCaseCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a Case.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>RateHigh</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a high incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>RateHighCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a high incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>RateLow</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a low incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>RateLowCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a low incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>RateMedium</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a medium incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>RateMediumCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a medium incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>RateRfc</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a RFC.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>RateRfcCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a RFC.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>RateRfi</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a RFI.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>RateRfiCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a RFI.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>RateTop</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a top incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>RateTopCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a top incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>RecoveryPointObjective</maml:name> <maml:description> <maml:para>The Recovery Point Objective (RPO) is the maximum targeted duration in minutes in which data (transactions) might be lost from an IT service due to a major incident.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>RecoveryTimeObjective</maml:name> <maml:description> <maml:para>The Recovery Time Objective (RTO) is the maximum targeted duration in minutes in which a business process must be restored after a disaster (or disruption) in order to avoid unacceptable consequences associated with a break in business continuity.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Reliability</maml:name> <maml:description> <maml:para>Used to specify the maximum number of times per month that the service may become unavailable to customers with an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>ReportFrequency</maml:name> <maml:description> <maml:para>Used to specify how often the representative of a customer of an active SLA that is based on the service offering will receive a report comparing the service level targets specified in the service offering with the actual level of service provided.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingReportFrequency</command:parameterValue> <dev:type> <maml:name>ServiceOfferingReportFrequency</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>ResolutionsWithinTarget</maml:name> <maml:description> <maml:para>The minimum percentage of incidents that is to be resolved before their resolution target.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>ResolutionTargetCase</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the category "Case" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>ResolutionTargetHigh</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "High - Service Degraded for Several Users" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>ResolutionTargetLow</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "Low - Service Degraded for One User" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>ResolutionTargetMedium</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "Medium - Service Down for One User" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>ResolutionTargetRfc</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the category "RFC - Request for Change" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="46"> <maml:name>ResolutionTargetRfi</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the category "RFI - Request for Information" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="47"> <maml:name>ResolutionTargetTop</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "Top - Service Down for Several Users" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="48"> <maml:name>ResponsesWithinTarget</maml:name> <maml:description> <maml:para>The minimum percentage of incidents that is to be responded to before their response target.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="49"> <maml:name>ResponseTargetCase</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the category "Case" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="50"> <maml:name>ResponseTargetHigh</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "High - Service Degraded for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="51"> <maml:name>ResponseTargetLow</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "Low - Service Degraded for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="52"> <maml:name>ResponseTargetMedium</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "Medium - Service Down for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="53"> <maml:name>ResponseTargetRfc</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the category "RFC - Request for Change" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="54"> <maml:name>ResponseTargetRfi</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the category "RFI - Request for Information" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="55"> <maml:name>ResponseTargetTop</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "Top - Service Down for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="56"> <maml:name>ReviewFrequency</maml:name> <maml:description> <maml:para>How often an active SLA that is based on the service offering will be reviewed with the representative of its customer.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingReviewFrequency</command:parameterValue> <dev:type> <maml:name>ServiceOfferingReviewFrequency</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="57"> <maml:name>ServiceHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the hours during which the service is supposed to be available.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="58"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the service offering is being prepared.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="59"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="60"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="61"> <maml:name>StandardServiceRequestsToDelete</maml:name> <maml:description> <maml:para>Identifiers of standard service requests to remove from the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="62"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingStatus</command:parameterValue> <dev:type> <maml:name>ServiceOfferingStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="63"> <maml:name>Summary</maml:name> <maml:description> <maml:para>A high-level description of the differentiators between this service offering and other service offerings that have already been, or could be, prepared for the same service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="64"> <maml:name>SupportHoursCaseId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the category "Case" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="65"> <maml:name>SupportHoursHighId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "High - Service Degraded for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="66"> <maml:name>SupportHoursLowId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "Low - Service Degraded for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="67"> <maml:name>SupportHoursMediumId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "Medium - Service Down for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="68"> <maml:name>SupportHoursRfcId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the category "RFC - Request for Change" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="69"> <maml:name>SupportHoursRfiId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the category "RFI - Request for Information" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="70"> <maml:name>SupportHoursTopId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "Top - Service Down for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="71"> <maml:name>Termination</maml:name> <maml:description> <maml:para>Used to describe the length of notice required for changing or terminating the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="72"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected service hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="73"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service offering properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceOfferingField[]</command:parameterValue> <dev:type> <maml:name>ServiceOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="74"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Availability</maml:name> <maml:description> <maml:para>The duration, expressed as percentage of the total number of service hours, during which the service is to be available to customers with an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Charges</maml:name> <maml:description> <maml:para>The amount that the service provider will charge the customer for the delivery of the service per charge driver, per charge term.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ChargeTypeCase</maml:name> <maml:description> <maml:para>Defines how a Case must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ChargeTypeHigh</maml:name> <maml:description> <maml:para>Defines how a high incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ChargeTypeLow</maml:name> <maml:description> <maml:para>Defines how a low incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ChargeTypeMedium</maml:name> <maml:description> <maml:para>Defines how a medium incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ChargeTypeRfc</maml:name> <maml:description> <maml:para>Defines how a RFC must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ChargeTypeRfi</maml:name> <maml:description> <maml:para>Defines how a RFI must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ChargeTypeTop</maml:name> <maml:description> <maml:para>Defines how a top incident must be charged: as a Fixed Price or in Time and Materials.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingChargeType</command:parameterValue> <dev:type> <maml:name>ServiceOfferingChargeType</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Continuity</maml:name> <maml:description> <maml:para>The continuity measures for the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>DefaultEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a request with an affected SLA linked to this service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>EffortClassIds</maml:name> <maml:description> <maml:para>Identifiers of effort classes of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>EffortClassRatesToDelete</maml:name> <maml:description> <maml:para>Identifiers of effort class rates to remove from the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Limitations</maml:name> <maml:description> <maml:para>The limitations that apply to the service level agreements that are based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>NewEffortClassRates</maml:name> <maml:description> <maml:para>Effort class rates of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">EffortClassRateInput[]</command:parameterValue> <dev:type> <maml:name>EffortClassRateInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>NewStandardServiceRequests</maml:name> <maml:description> <maml:para>Standard service requests of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">StandardServiceRequestInput[]</command:parameterValue> <dev:type> <maml:name>StandardServiceRequestInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Penalties</maml:name> <maml:description> <maml:para>Used to specify what the penalties will be for the service provider organization if a service level target has been breached.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Performance</maml:name> <maml:description> <maml:para>Used to describe the transaction(s) and the maximum time these transaction(s) can take to complete.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Prerequisites</maml:name> <maml:description> <maml:para>Used to specify which requirements need to be met by the customer in order for the customer to be able to benefit from the service. The service provider cannot be held accountable for breaches of the service level targets caused by a failure of the customer to meet one or more of these prerequisites.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>RateCase</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a Case.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>RateCaseCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a Case.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>RateHigh</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a high incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>RateHighCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a high incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>RateLow</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a low incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>RateLowCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a low incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>RateMedium</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a medium incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>RateMediumCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a medium incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>RateRfc</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a RFC.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>RateRfcCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a RFC.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>RateRfi</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a RFI.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>RateRfiCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a RFI.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>RateTop</maml:name> <maml:description> <maml:para>Defines the fixed price rate for a top incident.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>RateTopCurrency</maml:name> <maml:description> <maml:para>Defines the currency for the fixed price rate of a top incident.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>RecoveryPointObjective</maml:name> <maml:description> <maml:para>The Recovery Point Objective (RPO) is the maximum targeted duration in minutes in which data (transactions) might be lost from an IT service due to a major incident.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>RecoveryTimeObjective</maml:name> <maml:description> <maml:para>The Recovery Time Objective (RTO) is the maximum targeted duration in minutes in which a business process must be restored after a disaster (or disruption) in order to avoid unacceptable consequences associated with a break in business continuity.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>Reliability</maml:name> <maml:description> <maml:para>Used to specify the maximum number of times per month that the service may become unavailable to customers with an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>ReportFrequency</maml:name> <maml:description> <maml:para>Used to specify how often the representative of a customer of an active SLA that is based on the service offering will receive a report comparing the service level targets specified in the service offering with the actual level of service provided.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingReportFrequency</command:parameterValue> <dev:type> <maml:name>ServiceOfferingReportFrequency</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>ResolutionsWithinTarget</maml:name> <maml:description> <maml:para>The minimum percentage of incidents that is to be resolved before their resolution target.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>ResolutionTargetCase</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the category "Case" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>ResolutionTargetHigh</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "High - Service Degraded for Several Users" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>ResolutionTargetLow</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "Low - Service Degraded for One User" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="44"> <maml:name>ResolutionTargetMedium</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "Medium - Service Down for One User" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>ResolutionTargetRfc</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the category "RFC - Request for Change" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="46"> <maml:name>ResolutionTargetRfi</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the category "RFI - Request for Information" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="47"> <maml:name>ResolutionTargetTop</maml:name> <maml:description> <maml:para>The number of minutes within which a request with the impact value "Top - Service Down for Several Users" is to be resolved when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="48"> <maml:name>ResponsesWithinTarget</maml:name> <maml:description> <maml:para>The minimum percentage of incidents that is to be responded to before their response target.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="49"> <maml:name>ResponseTargetCase</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the category "Case" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="50"> <maml:name>ResponseTargetHigh</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "High - Service Degraded for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="51"> <maml:name>ResponseTargetLow</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "Low - Service Degraded for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="52"> <maml:name>ResponseTargetMedium</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "Medium - Service Down for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="53"> <maml:name>ResponseTargetRfc</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the category "RFC - Request for Change" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="54"> <maml:name>ResponseTargetRfi</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the category "RFI - Request for Information" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="55"> <maml:name>ResponseTargetTop</maml:name> <maml:description> <maml:para>The number of minutes within which a response needs to have been provided for a request with the impact "Top - Service Down for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="56"> <maml:name>ReviewFrequency</maml:name> <maml:description> <maml:para>How often an active SLA that is based on the service offering will be reviewed with the representative of its customer.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingReviewFrequency</command:parameterValue> <dev:type> <maml:name>ServiceOfferingReviewFrequency</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="57"> <maml:name>ServiceHoursId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the hours during which the service is supposed to be available.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="58"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the service offering is being prepared.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="59"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="60"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="61"> <maml:name>StandardServiceRequestsToDelete</maml:name> <maml:description> <maml:para>Identifiers of standard service requests to remove from the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="62"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the service offering.</maml:para> </maml:description> <command:parameterValue required="false">ServiceOfferingStatus</command:parameterValue> <dev:type> <maml:name>ServiceOfferingStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="63"> <maml:name>Summary</maml:name> <maml:description> <maml:para>A high-level description of the differentiators between this service offering and other service offerings that have already been, or could be, prepared for the same service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="64"> <maml:name>SupportHoursCaseId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the category "Case" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="65"> <maml:name>SupportHoursHighId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "High - Service Degraded for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="66"> <maml:name>SupportHoursLowId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "Low - Service Degraded for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="67"> <maml:name>SupportHoursMediumId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "Medium - Service Down for One User" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="68"> <maml:name>SupportHoursRfcId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the category "RFC - Request for Change" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="69"> <maml:name>SupportHoursRfiId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the category "RFI - Request for Information" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="70"> <maml:name>SupportHoursTopId</maml:name> <maml:description> <maml:para>Identifier of the calendar that defines the support hours for a request with the impact "Top - Service Down for Several Users" when it affects an active SLA that is based on the service offering.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="71"> <maml:name>Termination</maml:name> <maml:description> <maml:para>Used to describe the length of notice required for changing or terminating the service level agreement.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="72"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected service hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="73"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service offering properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServiceOfferingField[]</command:parameterValue> <dev:type> <maml:name>ServiceOfferingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="74"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingChargeType</maml:name> </dev:type> <maml:description> <maml:para>A service offering charge type object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.EffortClassRateInput[]</maml:name> </dev:type> <maml:description> <maml:para>An effort class rate input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.StandardServiceRequestInput[]</maml:name> </dev:type> <maml:description> <maml:para>A standard service request input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingReportFrequency</maml:name> </dev:type> <maml:description> <maml:para>A service offering report frequency object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingReviewFrequency</maml:name> </dev:type> <maml:description> <maml:para>A service offering review frequency object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingStatus</maml:name> </dev:type> <maml:description> <maml:para>A service offering status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ServiceOfferingField[]</maml:name> </dev:type> <maml:description> <maml:para>The service offering field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ServiceOffering</maml:name> </dev:type> <maml:description> <maml:para>A service offering object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentShopArticle</command:name> <command:verb>Set</command:verb> <command:noun>XurrentShopArticle</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a shop article.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a shop article using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentShopArticle</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CalendarId</maml:name> <maml:description> <maml:para>Calendar that represents the work hours related to the fulfillment/delivery.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DeliveryDuration</maml:name> <maml:description> <maml:para>The number of minutes it usually takes to deliver the shop article.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the shop article is visible in the shop.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>After this moment the shop article is no longer available in the shop.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>FulfillmentTemplateId</maml:name> <maml:description> <maml:para>The request template used to order one of more units of this shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>FullDescription</maml:name> <maml:description> <maml:para>The full description of the shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaxQuantity</maml:name> <maml:description> <maml:para>The largest number of units that may be bought at once.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Name</maml:name> <maml:description> <maml:para>The display name of the shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Price</maml:name> <maml:description> <maml:para>The price of a single unit.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>PriceCurrency</maml:name> <maml:description> <maml:para>The currency of the price of this shop article.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Related product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RecurringPeriod</maml:name> <maml:description> <maml:para>The frequency in which the recurring price is due.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleRecurringPeriod</command:parameterValue> <dev:type> <maml:name>ShopArticleRecurringPeriod</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RecurringPrice</maml:name> <maml:description> <maml:para>The recurring price of a single unit.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RecurringPriceCurrency</maml:name> <maml:description> <maml:para>The currency of the recurring price of this shop article.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Reference</maml:name> <maml:description> <maml:para>This reference can be used to link the shop article to a shop order line using the Xurrent APIs or the Xurrent Import functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RequiresShipping</maml:name> <maml:description> <maml:para>Whether or not this is a physical article that requires shipping.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ShortDescription</maml:name> <maml:description> <maml:para>The shop description of the shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The moment the shop article becomes available in the shop.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The Time zone related to the calendar.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="25"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of shop article properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopArticleField[]</command:parameterValue> <dev:type> <maml:name>ShopArticleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CalendarId</maml:name> <maml:description> <maml:para>Calendar that represents the work hours related to the fulfillment/delivery.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DeliveryDuration</maml:name> <maml:description> <maml:para>The number of minutes it usually takes to deliver the shop article.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the shop article is visible in the shop.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>After this moment the shop article is no longer available in the shop.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>FulfillmentTemplateId</maml:name> <maml:description> <maml:para>The request template used to order one of more units of this shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>FullDescription</maml:name> <maml:description> <maml:para>The full description of the shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaxQuantity</maml:name> <maml:description> <maml:para>The largest number of units that may be bought at once.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Name</maml:name> <maml:description> <maml:para>The display name of the shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Price</maml:name> <maml:description> <maml:para>The price of a single unit.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>PriceCurrency</maml:name> <maml:description> <maml:para>The currency of the price of this shop article.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Related product.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RecurringPeriod</maml:name> <maml:description> <maml:para>The frequency in which the recurring price is due.</maml:para> </maml:description> <command:parameterValue required="false">ShopArticleRecurringPeriod</command:parameterValue> <dev:type> <maml:name>ShopArticleRecurringPeriod</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RecurringPrice</maml:name> <maml:description> <maml:para>The recurring price of a single unit.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>RecurringPriceCurrency</maml:name> <maml:description> <maml:para>The currency of the recurring price of this shop article.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Reference</maml:name> <maml:description> <maml:para>This reference can be used to link the shop article to a shop order line using the Xurrent APIs or the Xurrent Import functionality.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RequiresShipping</maml:name> <maml:description> <maml:para>Whether or not this is a physical article that requires shipping.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ShortDescription</maml:name> <maml:description> <maml:para>The shop description of the shop article.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The moment the shop article becomes available in the shop.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The Time zone related to the calendar.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="25"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of shop article properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopArticleField[]</command:parameterValue> <dev:type> <maml:name>ShopArticleField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleRecurringPeriod</maml:name> </dev:type> <maml:description> <maml:para>A shop article recurring period object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleField[]</maml:name> </dev:type> <maml:description> <maml:para>The shop article field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShopArticle</maml:name> </dev:type> <maml:description> <maml:para>A shop article object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentShopArticleCategory</command:name> <command:verb>Set</command:verb> <command:noun>XurrentShopArticleCategory</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a shop article category.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a shop article category using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentShopArticleCategory</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>FullDescription</maml:name> <maml:description> <maml:para>The full description of the shop article category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>FullDescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the fullDescription field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Name</maml:name> <maml:description> <maml:para>The display name of the shop article category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ParentId</maml:name> <maml:description> <maml:para>Identifier of the category's parent category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ShortDescription</maml:name> <maml:description> <maml:para>The shop description of the shop article category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of shop article category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopArticleCategoryField[]</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>FullDescription</maml:name> <maml:description> <maml:para>The full description of the shop article category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>FullDescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the fullDescription field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Name</maml:name> <maml:description> <maml:para>The display name of the shop article category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ParentId</maml:name> <maml:description> <maml:para>Identifier of the category's parent category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ShortDescription</maml:name> <maml:description> <maml:para>The shop description of the shop article category.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of shop article category properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopArticleCategoryField[]</command:parameterValue> <dev:type> <maml:name>ShopArticleCategoryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopArticleCategoryField[]</maml:name> </dev:type> <maml:description> <maml:para>The shop article category field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShopArticleCategory</maml:name> </dev:type> <maml:description> <maml:para>A shop article category object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentShopOrderLine</command:name> <command:verb>Set</command:verb> <command:noun>XurrentShopOrderLine</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a shop order line.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a shop order line using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentShopOrderLine</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of the shop order line.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Quantity</maml:name> <maml:description> <maml:para>The number units ordered.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>RequestedForId</maml:name> <maml:description> <maml:para>The person for whom the shop order line was submitted.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ShopArticleId</maml:name> <maml:description> <maml:para>The shop article that is ordered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of shop order line properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopOrderLineField[]</command:parameterValue> <dev:type> <maml:name>ShopOrderLineField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of the shop order line.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Quantity</maml:name> <maml:description> <maml:para>The number units ordered.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>RequestedForId</maml:name> <maml:description> <maml:para>The person for whom the shop order line was submitted.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ShopArticleId</maml:name> <maml:description> <maml:para>The shop article that is ordered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of shop order line properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShopOrderLineField[]</command:parameterValue> <dev:type> <maml:name>ShopOrderLineField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressInput[]</maml:name> </dev:type> <maml:description> <maml:para>An address input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShopOrderLineField[]</maml:name> </dev:type> <maml:description> <maml:para>The shop order line field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShopOrderLine</maml:name> </dev:type> <maml:description> <maml:para>A shop order line object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentShortUrl</command:name> <command:verb>Set</command:verb> <command:noun>XurrentShortUrl</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a short uniform resource locator.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a short uniform resource locator using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentShortUrl</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CiId</maml:name> <maml:description> <maml:para>Identifier of the CI for which a request is to be registered in Xurrent Self Service when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DashboardId</maml:name> <maml:description> <maml:para>Identifier of the dashboard which is to be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Email</maml:name> <maml:description> <maml:para>Values for email that is to be generated when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlEmailInput</command:parameterValue> <dev:type> <maml:name>ShortUrlEmailInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Geo</maml:name> <maml:description> <maml:para>Coordinates of the location for which a map should be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlGeoInput</command:parameterValue> <dev:type> <maml:name>ShortUrlGeoInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>KnowledgeArticleId</maml:name> <maml:description> <maml:para>Identifier of the knowledge article which instructions need to be displayed when the short URL is used in Xurrent Self Service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MapAddress</maml:name> <maml:description> <maml:para>The address (or only the city or country) for which a map should be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>PlainText</maml:name> <maml:description> <maml:para>The Plain text field is used to enter the text that should be displayed when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>RequestTemplateId</maml:name> <maml:description> <maml:para>The identifier of the request template that is to be applied to each new request that is opened when in Xurrent Self Service when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SkypeName</maml:name> <maml:description> <maml:para>The Skype name that is to be called when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Sms</maml:name> <maml:description> <maml:para>Values for the SMS message that is to be generated when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlSmsInput</command:parameterValue> <dev:type> <maml:name>ShortUrlSmsInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Tel</maml:name> <maml:description> <maml:para>The telephone number that is to be called when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>The Twitter tweet that is to be generated when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>TwitterName</maml:name> <maml:description> <maml:para>The name of the Twitter user whose Twitter feed is to be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The uniform resource identifier (URI) to which the short URL is forwarded.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>WebsiteUrl</maml:name> <maml:description> <maml:para>The uniform resource locator of a website to which the short URL is to forward when it is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="17"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of short uniform resource locator properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShortUrlField[]</command:parameterValue> <dev:type> <maml:name>ShortUrlField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>CiId</maml:name> <maml:description> <maml:para>Identifier of the CI for which a request is to be registered in Xurrent Self Service when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DashboardId</maml:name> <maml:description> <maml:para>Identifier of the dashboard which is to be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Email</maml:name> <maml:description> <maml:para>Values for email that is to be generated when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlEmailInput</command:parameterValue> <dev:type> <maml:name>ShortUrlEmailInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Geo</maml:name> <maml:description> <maml:para>Coordinates of the location for which a map should be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlGeoInput</command:parameterValue> <dev:type> <maml:name>ShortUrlGeoInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>KnowledgeArticleId</maml:name> <maml:description> <maml:para>Identifier of the knowledge article which instructions need to be displayed when the short URL is used in Xurrent Self Service.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MapAddress</maml:name> <maml:description> <maml:para>The address (or only the city or country) for which a map should be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>PlainText</maml:name> <maml:description> <maml:para>The Plain text field is used to enter the text that should be displayed when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>RequestTemplateId</maml:name> <maml:description> <maml:para>The identifier of the request template that is to be applied to each new request that is opened when in Xurrent Self Service when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SkypeName</maml:name> <maml:description> <maml:para>The Skype name that is to be called when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Sms</maml:name> <maml:description> <maml:para>Values for the SMS message that is to be generated when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">ShortUrlSmsInput</command:parameterValue> <dev:type> <maml:name>ShortUrlSmsInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Tel</maml:name> <maml:description> <maml:para>The telephone number that is to be called when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>The Twitter tweet that is to be generated when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>TwitterName</maml:name> <maml:description> <maml:para>The name of the Twitter user whose Twitter feed is to be opened when the short URL is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The uniform resource identifier (URI) to which the short URL is forwarded.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>WebsiteUrl</maml:name> <maml:description> <maml:para>The uniform resource locator of a website to which the short URL is to forward when it is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="17"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of short uniform resource locator properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ShortUrlField[]</command:parameterValue> <dev:type> <maml:name>ShortUrlField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShortUrlEmailInput</maml:name> </dev:type> <maml:description> <maml:para>A short uniform resource locator email input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShortUrlGeoInput</maml:name> </dev:type> <maml:description> <maml:para>A short uniform resource locator geo input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShortUrlSmsInput</maml:name> </dev:type> <maml:description> <maml:para>A short uniform resource locator sms input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.ShortUrlField[]</maml:name> </dev:type> <maml:description> <maml:para>The short uniform resource locator field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ShortUrl</maml:name> </dev:type> <maml:description> <maml:para>A short uniform resource locator object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentSite</command:name> <command:verb>Set</command:verb> <command:noun>XurrentSite</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a site.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a site using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentSite</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AddressesToDelete</maml:name> <maml:description> <maml:para>Identifiers of addresses to remove from the site.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Default: false - Whether the site may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the site or facility.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of the site.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the site that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone in which the site is located.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="15"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of site properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteField[]</command:parameterValue> <dev:type> <maml:name>SiteField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AddressesToDelete</maml:name> <maml:description> <maml:para>Identifiers of addresses to remove from the site.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Default: false - Whether the site may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the site or facility.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>NewAddresses</maml:name> <maml:description> <maml:para>New or updated addresses of the site.</maml:para> </maml:description> <command:parameterValue required="false">AddressInput[]</command:parameterValue> <dev:type> <maml:name>AddressInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the site that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone in which the site is located.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="15"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of site properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteField[]</command:parameterValue> <dev:type> <maml:name>SiteField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AddressInput[]</maml:name> </dev:type> <maml:description> <maml:para>An address input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SiteField[]</maml:name> </dev:type> <maml:description> <maml:para>The site field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Site</maml:name> </dev:type> <maml:description> <maml:para>A site object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentSkillPool</command:name> <command:verb>Set</command:verb> <command:noun>XurrentSkillPool</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a skill pool.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a skill pool using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentSkillPool</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CostPerHour</maml:name> <maml:description> <maml:para>The skill pool's estimated total cost per work hour for the service provider organization.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CostPerHourCurrency</maml:name> <maml:description> <maml:para>The currency of the cost per hour value attributed to this skill pool.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the skill pool may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EffortClassIds</maml:name> <maml:description> <maml:para>Effort classes that are linked to the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager or supervisor of the skill pool. This person is able to maintain the information about the skill pool. The manager of a skill pool does not need to be a member of the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MemberIds</maml:name> <maml:description> <maml:para>People that are linked as member to the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the skill pool that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="14"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of skill pool properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SkillPoolField[]</command:parameterValue> <dev:type> <maml:name>SkillPoolField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CostPerHour</maml:name> <maml:description> <maml:para>The skill pool's estimated total cost per work hour for the service provider organization.</maml:para> </maml:description> <command:parameterValue required="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CostPerHourCurrency</maml:name> <maml:description> <maml:para>The currency of the cost per hour value attributed to this skill pool.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the skill pool may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EffortClassIds</maml:name> <maml:description> <maml:para>Effort classes that are linked to the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager or supervisor of the skill pool. This person is able to maintain the information about the skill pool. The manager of a skill pool does not need to be a member of the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MemberIds</maml:name> <maml:description> <maml:para>People that are linked as member to the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the skill pool.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the skill pool that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="14"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of skill pool properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SkillPoolField[]</command:parameterValue> <dev:type> <maml:name>SkillPoolField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Decimal</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.decimal</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SkillPoolField[]</maml:name> </dev:type> <maml:description> <maml:para>The skill pool field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SkillPool</maml:name> </dev:type> <maml:description> <maml:para>A skill pool object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentSlaCoverageGroup</command:name> <command:verb>Set</command:verb> <command:noun>XurrentSlaCoverageGroup</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a service level agreement coverage group.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a service level agreement coverage group using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentSlaCoverageGroup</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Any additional information about the SLA coverage group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the SLA coverage group may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the SLA coverage group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SearchPhrase</maml:name> <maml:description> <maml:para>The phrase used to filter the people.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service level agreement coverage group properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaCoverageGroupField[]</command:parameterValue> <dev:type> <maml:name>SlaCoverageGroupField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Any additional information about the SLA coverage group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the SLA coverage group may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the SLA coverage group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SearchPhrase</maml:name> <maml:description> <maml:para>The phrase used to filter the people.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service level agreement coverage group properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaCoverageGroupField[]</command:parameterValue> <dev:type> <maml:name>SlaCoverageGroupField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaCoverageGroupField[]</maml:name> </dev:type> <maml:description> <maml:para>The service level agreement coverage group field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SlaCoverageGroup</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement coverage group object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentSlaNotificationScheme</command:name> <command:verb>Set</command:verb> <command:noun>XurrentSlaNotificationScheme</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a service level agreement notification scheme.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a service level agreement notification scheme using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentSlaNotificationScheme</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the SLA notification scheme may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the SLA notification scheme.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewSlaNotificationRules</maml:name> <maml:description> <maml:para>Rules of this SLA notification scheme.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationRuleInput[]</command:parameterValue> <dev:type> <maml:name>SlaNotificationRuleInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SlaNotificationRulesToDelete</maml:name> <maml:description> <maml:para>Identifiers of rules to remove from the scheme.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="8"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service level agreement notification scheme properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaNotificationSchemeField[]</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the SLA notification scheme may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the SLA notification scheme.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewSlaNotificationRules</maml:name> <maml:description> <maml:para>Rules of this SLA notification scheme.</maml:para> </maml:description> <command:parameterValue required="false">SlaNotificationRuleInput[]</command:parameterValue> <dev:type> <maml:name>SlaNotificationRuleInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SlaNotificationRulesToDelete</maml:name> <maml:description> <maml:para>Identifiers of rules to remove from the scheme.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="8"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of service level agreement notification scheme properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SlaNotificationSchemeField[]</command:parameterValue> <dev:type> <maml:name>SlaNotificationSchemeField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaNotificationRuleInput[]</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement notification rule input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SlaNotificationSchemeField[]</maml:name> </dev:type> <maml:description> <maml:para>The service level agreement notification scheme field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SlaNotificationScheme</maml:name> </dev:type> <maml:description> <maml:para>A service level agreement notification scheme object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentSprint</command:name> <command:verb>Set</command:verb> <command:noun>XurrentSprint</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a sprint.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a sprint using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentSprint</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of this sprint (e.g. goal of the sprint).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>The date and time the sprint ended, or will end.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>NewSprintBacklogItems</maml:name> <maml:description> <maml:para>Sprint backlog items of this sprint.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemInput[]</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Number</maml:name> <maml:description> <maml:para>Sequence number of this sprint.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ScrumWorkspaceId</maml:name> <maml:description> <maml:para>Identifier of scrum workspace this sprint belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SprintBacklogItemsToDelete</maml:name> <maml:description> <maml:para>Identifiers of sprint backlog items to remove from the sprint.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The date and time the sprint started, or will start.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the sprint.</maml:para> </maml:description> <command:parameterValue required="false">SprintStatus</command:parameterValue> <dev:type> <maml:name>SprintStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of sprint properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SprintField[]</command:parameterValue> <dev:type> <maml:name>SprintField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of this sprint (e.g. goal of the sprint).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EndAt</maml:name> <maml:description> <maml:para>The date and time the sprint ended, or will end.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>NewSprintBacklogItems</maml:name> <maml:description> <maml:para>Sprint backlog items of this sprint.</maml:para> </maml:description> <command:parameterValue required="false">SprintBacklogItemInput[]</command:parameterValue> <dev:type> <maml:name>SprintBacklogItemInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Number</maml:name> <maml:description> <maml:para>Sequence number of this sprint.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ScrumWorkspaceId</maml:name> <maml:description> <maml:para>Identifier of scrum workspace this sprint belongs to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SprintBacklogItemsToDelete</maml:name> <maml:description> <maml:para>Identifiers of sprint backlog items to remove from the sprint.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The date and time the sprint started, or will start.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Status</maml:name> <maml:description> <maml:para>The current status of the sprint.</maml:para> </maml:description> <command:parameterValue required="false">SprintStatus</command:parameterValue> <dev:type> <maml:name>SprintStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="13"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of sprint properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SprintField[]</command:parameterValue> <dev:type> <maml:name>SprintField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintBacklogItemInput[]</maml:name> </dev:type> <maml:description> <maml:para>A sprint backlog item input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintStatus</maml:name> </dev:type> <maml:description> <maml:para>A sprint status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SprintField[]</maml:name> </dev:type> <maml:description> <maml:para>The sprint field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Sprint</maml:name> </dev:type> <maml:description> <maml:para>A sprint object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentSurvey</command:name> <command:verb>Set</command:verb> <command:noun>XurrentSurvey</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a survey.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a survey using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentSurvey</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the survey may not be used.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the survey.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewQuestions</maml:name> <maml:description> <maml:para>Questions of this survey.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuestionInput[]</command:parameterValue> <dev:type> <maml:name>SurveyQuestionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>QuestionsToDelete</maml:name> <maml:description> <maml:para>Identifiers of questions to remove from the survey.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of survey properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyField[]</command:parameterValue> <dev:type> <maml:name>SurveyField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the survey may not be used.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the survey.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewQuestions</maml:name> <maml:description> <maml:para>Questions of this survey.</maml:para> </maml:description> <command:parameterValue required="false">SurveyQuestionInput[]</command:parameterValue> <dev:type> <maml:name>SurveyQuestionInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>QuestionsToDelete</maml:name> <maml:description> <maml:para>Identifiers of questions to remove from the survey.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of survey properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyField[]</command:parameterValue> <dev:type> <maml:name>SurveyField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyQuestionInput[]</maml:name> </dev:type> <maml:description> <maml:para>A survey question input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyField[]</maml:name> </dev:type> <maml:description> <maml:para>The survey field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Survey</maml:name> </dev:type> <maml:description> <maml:para>A survey object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentSurveyResponse</command:name> <command:verb>Set</command:verb> <command:noun>XurrentSurveyResponse</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a survey response.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a survey response using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentSurveyResponse</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AnswersToDelete</maml:name> <maml:description> <maml:para>Identifiers of answers to remove from the survey.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Completed</maml:name> <maml:description> <maml:para>Whether the respondent completed the survey.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewAnswers</maml:name> <maml:description> <maml:para>Answers of this survey response.</maml:para> </maml:description> <command:parameterValue required="false">SurveyAnswerInput[]</command:parameterValue> <dev:type> <maml:name>SurveyAnswerInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person who provided this response (i.e. the respondent).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Rating</maml:name> <maml:description> <maml:para>Rating calculated based on the answers.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>RatingCalculation</maml:name> <maml:description> <maml:para>How the individual answers were combined to calculate the rating.</maml:para> </maml:description> <command:parameterValue required="false">JToken</command:parameterValue> <dev:type> <maml:name>JToken</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>RespondedAt</maml:name> <maml:description> <maml:para>Time this response was submitted.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service this response is about.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SlaIds</maml:name> <maml:description> <maml:para>Identifiers of the SLAs this response is for. (Ignored when supplying a personId.)</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SurveyId</maml:name> <maml:description> <maml:para>Identifier of the survey this response is for.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="14"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of survey response properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyResponseField[]</command:parameterValue> <dev:type> <maml:name>SurveyResponseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AnswersToDelete</maml:name> <maml:description> <maml:para>Identifiers of answers to remove from the survey.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Completed</maml:name> <maml:description> <maml:para>Whether the respondent completed the survey.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>NewAnswers</maml:name> <maml:description> <maml:para>Answers of this survey response.</maml:para> </maml:description> <command:parameterValue required="false">SurveyAnswerInput[]</command:parameterValue> <dev:type> <maml:name>SurveyAnswerInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person who provided this response (i.e. the respondent).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Rating</maml:name> <maml:description> <maml:para>Rating calculated based on the answers.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>RatingCalculation</maml:name> <maml:description> <maml:para>How the individual answers were combined to calculate the rating.</maml:para> </maml:description> <command:parameterValue required="false">JToken</command:parameterValue> <dev:type> <maml:name>JToken</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>RespondedAt</maml:name> <maml:description> <maml:para>Time this response was submitted.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service this response is about.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SlaIds</maml:name> <maml:description> <maml:para>Identifiers of the SLAs this response is for. (Ignored when supplying a personId.)</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SurveyId</maml:name> <maml:description> <maml:para>Identifier of the survey this response is for.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="14"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of survey response properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SurveyResponseField[]</command:parameterValue> <dev:type> <maml:name>SurveyResponseField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyAnswerInput[]</maml:name> </dev:type> <maml:description> <maml:para>A survey answer input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Newtonsoft.Json.Linq.JToken</maml:name> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.SurveyResponseField[]</maml:name> </dev:type> <maml:description> <maml:para>The survey response field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SurveyResponse</maml:name> </dev:type> <maml:description> <maml:para>A survey response object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentTask</command:name> <command:verb>Set</command:verb> <command:noun>XurrentTask</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a task.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a task using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentTask</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ApprovalsToDelete</maml:name> <maml:description> <maml:para>Identifiers of approvals to delete.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignedAt</maml:name> <maml:description> <maml:para>Automatically set to the current date and time when the task is assigned.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the task. Risk & impact tasks are used to help plan workflows. Approval tasks are used to collect approvals for workflows. These can be used at various stages in the life of the workflow. Implementation tasks are added to workflows for development, installation, configuration, test, transfer and administrative work that needs to be completed for the implementation of the workflow.</maml:para> </maml:description> <command:parameterValue required="false">TaskCategory</command:parameterValue> <dev:type> <maml:name>TaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FinishedAt</maml:name> <maml:description> <maml:para>Automatically set to the date and time at which the task is saved with the status "Failed", "Rejected", "Completed", "Approved" or "Canceled".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Impact</maml:name> <maml:description> <maml:para>The extent to which the service instances related to the task will be impacted by the completion of the task.</maml:para> </maml:description> <command:parameterValue required="false">TaskImpact</command:parameterValue> <dev:type> <maml:name>TaskImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Used to provide instructions for the person to whom the task will be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the instructions field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person to whom the task is to be assigned. This field's value is null in case of an approval task with multiple approvers.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>NewApprovals</maml:name> <maml:description> <maml:para>Approvals of the task.</maml:para> </maml:description> <command:parameterValue required="false">TaskApprovalInput[]</command:parameterValue> <dev:type> <maml:name>TaskApprovalInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Note</maml:name> <maml:description> <maml:para>Used to provide information for the person to whom the task is assigned. It is also used to provide a summary of the actions that have been taken to date and the results of these actions.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>The attachments used in the note field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design associated with the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PhaseId</maml:name> <maml:description> <maml:para>Identifier of the phase of the workflow to which the task belongs.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>The number of minutes it is expected to take for the task to be completed following its assignment, or following its fixed start date and time if the Start no earlier than field is filled out.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>The number of minutes the member is expected to spend working on the task.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PredecessorIds</maml:name> <maml:description> <maml:para>Identifiers of predecessors of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>RequestServiceInstanceId</maml:name> <maml:description> <maml:para>The identifier of the service instance that should be used to create the request for this task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>RequestTemplateId</maml:name> <maml:description> <maml:para>The identifier of the request template that should be used to create the request for this task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number of approvers who need to have provided their approval before the status of the task gets updated to "Approved".</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of service instances of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Only used when work on the task may not start before a specific date and time.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Status</maml:name> <maml:description> <maml:para>The Status field is used to select the current status of the task.</maml:para> </maml:description> <command:parameterValue required="false">TaskStatus</command:parameterValue> <dev:type> <maml:name>TaskStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>SuccessorIds</maml:name> <maml:description> <maml:para>Identifiers of successors of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that has been asked to assist with the completion of the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request to help with the execution of the task has been registered at the supplier organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team to which the task is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>Identifier of the task template that was used to register the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether the task has been marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the task is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>Identifier of the workflow to which the task belongs.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>When set to true, the completion target of the task is calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="44"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of task properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskField[]</command:parameterValue> <dev:type> <maml:name>TaskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardColumnId</maml:name> <maml:description> <maml:para>ID of the column this item is placed in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AgileBoardColumnPosition</maml:name> <maml:description> <maml:para>The (one based) position of this item in its column.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>ID of the board this item is placed on.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ApprovalsToDelete</maml:name> <maml:description> <maml:para>Identifiers of approvals to delete.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignedAt</maml:name> <maml:description> <maml:para>Automatically set to the current date and time when the task is assigned.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the task. Risk & impact tasks are used to help plan workflows. Approval tasks are used to collect approvals for workflows. These can be used at various stages in the life of the workflow. Implementation tasks are added to workflows for development, installation, configuration, test, transfer and administrative work that needs to be completed for the implementation of the workflow.</maml:para> </maml:description> <command:parameterValue required="false">TaskCategory</command:parameterValue> <dev:type> <maml:name>TaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FinishedAt</maml:name> <maml:description> <maml:para>Automatically set to the date and time at which the task is saved with the status "Failed", "Rejected", "Completed", "Approved" or "Canceled".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Impact</maml:name> <maml:description> <maml:para>The extent to which the service instances related to the task will be impacted by the completion of the task.</maml:para> </maml:description> <command:parameterValue required="false">TaskImpact</command:parameterValue> <dev:type> <maml:name>TaskImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>Used to provide instructions for the person to whom the task will be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>InstructionsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the instructions field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person to whom the task is to be assigned. This field's value is null in case of an approval task with multiple approvers.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>NewApprovals</maml:name> <maml:description> <maml:para>Approvals of the task.</maml:para> </maml:description> <command:parameterValue required="false">TaskApprovalInput[]</command:parameterValue> <dev:type> <maml:name>TaskApprovalInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Note</maml:name> <maml:description> <maml:para>Used to provide information for the person to whom the task is assigned. It is also used to provide a summary of the actions that have been taken to date and the results of these actions.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>NoteAttachments</maml:name> <maml:description> <maml:para>The attachments used in the note field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design associated with the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PhaseId</maml:name> <maml:description> <maml:para>Identifier of the phase of the workflow to which the task belongs.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>The number of minutes it is expected to take for the task to be completed following its assignment, or following its fixed start date and time if the Start no earlier than field is filled out.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>The number of minutes the member is expected to spend working on the task.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PredecessorIds</maml:name> <maml:description> <maml:para>Identifiers of predecessors of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>RequestServiceInstanceId</maml:name> <maml:description> <maml:para>The identifier of the service instance that should be used to create the request for this task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>RequestTemplateId</maml:name> <maml:description> <maml:para>The identifier of the request template that should be used to create the request for this task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number of approvers who need to have provided their approval before the status of the task gets updated to "Approved".</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of service instances of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Only used when work on the task may not start before a specific date and time.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Status</maml:name> <maml:description> <maml:para>The Status field is used to select the current status of the task.</maml:para> </maml:description> <command:parameterValue required="false">TaskStatus</command:parameterValue> <dev:type> <maml:name>TaskStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>SuccessorIds</maml:name> <maml:description> <maml:para>Identifiers of successors of the task.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that has been asked to assist with the completion of the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>SupplierRequestID</maml:name> <maml:description> <maml:para>The identifier under which the request to help with the execution of the task has been registered at the supplier organization.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team to which the task is to be assigned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>Identifier of the task template that was used to register the task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The time that you have spent working on the request since you started to work on it or, if you already entered some time for this request, since you last added your time spent in it.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="39"> <maml:name>TimeSpentEffortClassId</maml:name> <maml:description> <maml:para>The effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether the task has been marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="41"> <maml:name>WaitingUntil</maml:name> <maml:description> <maml:para>The date and time at which the status of the task is to be updated from waiting_for to assigned. This field is available only when the Status field is set to waiting_for.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="42"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>Identifier of the workflow to which the task belongs.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="43"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>When set to true, the completion target of the task is calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="44"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of task properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskField[]</command:parameterValue> <dev:type> <maml:name>TaskField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="45"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskCategory</maml:name> </dev:type> <maml:description> <maml:para>A task category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskImpact</maml:name> </dev:type> <maml:description> <maml:para>A task impact object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskApprovalInput[]</maml:name> </dev:type> <maml:description> <maml:para>A task approval input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskStatus</maml:name> </dev:type> <maml:description> <maml:para>A task status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskField[]</maml:name> </dev:type> <maml:description> <maml:para>The task field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para>A task object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentTaskTemplate</command:name> <command:verb>Set</command:verb> <command:noun>XurrentTaskTemplate</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a task template.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a task template using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentTaskTemplate</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ApprovalsToDelete</maml:name> <maml:description> <maml:para>Identifiers of approvals to delete.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AssignToRequester</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Requested for field of the request for which the workflow is being generated.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AssignToRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the business unit to which the organization belongs that is linked to the person who is selected in the Requested for field of the request for which the workflow is being generated.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AssignToRequesterManager</maml:name> <maml:description> <maml:para>Whether the manager of the requester of the first related request is to be selected in the Approver field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignToServiceOwner</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Service owner field of the service that is linked to the workflow that the new task is a part of.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AssignToWorkflowManager</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the workflow to which the task belongs.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">TaskCategory</command:parameterValue> <dev:type> <maml:name>TaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the task template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CopyNotesToWorkflow</maml:name> <maml:description> <maml:para>Whether the Copy note to workflow box of tasks that were created based on the template needs to be checked by default. (The Copy notes to workflow checkbox is called "Copy notes to workflow by default" when the task template is in Edit mode.)</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the task template may not be used to help register new tasks.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a task created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Impact</maml:name> <maml:description> <maml:para>The impact level that needs to be selected in the Impact field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">TaskImpact</command:parameterValue> <dev:type> <maml:name>TaskImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Instructions field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person who should be selected in the Member field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>NewApprovals</maml:name> <maml:description> <maml:para>Approvals of the task template.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateApprovalInput[]</command:parameterValue> <dev:type> <maml:name>TaskTemplateApprovalInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design that needs to be copied to the PDF design field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>The number of minutes that should be entered in the Planned duration field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>The number of minutes the member is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PlannedEffortRequester</maml:name> <maml:description> <maml:para>The number of minutes the person, who is selected in the Requested for field of the first related request, is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>PlannedEffortRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>The number of minutes the business unit manager of the requester of the first related request is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PlannedEffortRequesterManager</maml:name> <maml:description> <maml:para>The number of minutes the manager of the requester of the first related request is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>PlannedEffortServiceOwner</maml:name> <maml:description> <maml:para>The number of minutes the owner of the service of the related to the workflow is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>PlannedEffortWorkflowManager</maml:name> <maml:description> <maml:para>The number of minutes the workflow manager is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>ProviderNotAccountable</maml:name> <maml:description> <maml:para>Default: false - Whether the provider indicates not to be accountable for the affected SLAs linked to the requests that are linked to the workflow of a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>RequestServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the service instance that should be selected in the Request service instance field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>RequestTemplateId</maml:name> <maml:description> <maml:para>Identifier of the request template that should be selected in the Request template field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number that needs to be specified in the Required approvals field of a new approval task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of the service instances of the task template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that should be selected in the Supplier field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team that should be selected in the Team field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether a new task that is created based on the template is to be marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>Whether the completion target of tasks created based on the template are calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="39"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of task template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskTemplateField[]</command:parameterValue> <dev:type> <maml:name>TaskTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ApprovalsToDelete</maml:name> <maml:description> <maml:para>Identifiers of approvals to delete.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AssignToRequester</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Requested for field of the request for which the workflow is being generated.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AssignToRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the business unit to which the organization belongs that is linked to the person who is selected in the Requested for field of the request for which the workflow is being generated.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AssignToRequesterManager</maml:name> <maml:description> <maml:para>Whether the manager of the requester of the first related request is to be selected in the Approver field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>AssignToServiceOwner</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Service owner field of the service that is linked to the workflow that the new task is a part of.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>AssignToWorkflowManager</maml:name> <maml:description> <maml:para>Whether a new task that is being created based on the template is to be assigned to the person who is selected in the Manager field of the workflow to which the task belongs.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">TaskCategory</command:parameterValue> <dev:type> <maml:name>TaskCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ConfigurationItemIds</maml:name> <maml:description> <maml:para>Identifiers of the configuration items of the task template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>CopyNotesToWorkflow</maml:name> <maml:description> <maml:para>Whether the Copy note to workflow box of tasks that were created based on the template needs to be checked by default. (The Copy notes to workflow checkbox is called "Copy notes to workflow by default" when the task template is in Edit mode.)</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the task template may not be used to help register new tasks.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on a task created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Impact</maml:name> <maml:description> <maml:para>The impact level that needs to be selected in the Impact field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">TaskImpact</command:parameterValue> <dev:type> <maml:name>TaskImpact</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Instructions field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Identifier of the person who should be selected in the Member field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>NewApprovals</maml:name> <maml:description> <maml:para>Approvals of the task template.</maml:para> </maml:description> <command:parameterValue required="false">TaskTemplateApprovalInput[]</command:parameterValue> <dev:type> <maml:name>TaskTemplateApprovalInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>PdfDesignId</maml:name> <maml:description> <maml:para>Identifier of the PDF design that needs to be copied to the PDF design field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>PlannedDuration</maml:name> <maml:description> <maml:para>The number of minutes that should be entered in the Planned duration field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PlannedEffort</maml:name> <maml:description> <maml:para>The number of minutes the member is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PlannedEffortRequester</maml:name> <maml:description> <maml:para>The number of minutes the person, who is selected in the Requested for field of the first related request, is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>PlannedEffortRequesterBusinessUnitManager</maml:name> <maml:description> <maml:para>The number of minutes the business unit manager of the requester of the first related request is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>PlannedEffortRequesterManager</maml:name> <maml:description> <maml:para>The number of minutes the manager of the requester of the first related request is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>PlannedEffortServiceOwner</maml:name> <maml:description> <maml:para>The number of minutes the owner of the service of the related to the workflow is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>PlannedEffortWorkflowManager</maml:name> <maml:description> <maml:para>The number of minutes the workflow manager is expected to spend working on a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>ProviderNotAccountable</maml:name> <maml:description> <maml:para>Default: false - Whether the provider indicates not to be accountable for the affected SLAs linked to the requests that are linked to the workflow of a task that was created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>RequestServiceInstanceId</maml:name> <maml:description> <maml:para>Identifier of the service instance that should be selected in the Request service instance field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="28"> <maml:name>RequestTemplateId</maml:name> <maml:description> <maml:para>Identifier of the request template that should be selected in the Request template field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="29"> <maml:name>RequiredApprovals</maml:name> <maml:description> <maml:para>The number that needs to be specified in the Required approvals field of a new approval task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="30"> <maml:name>ServiceInstanceIds</maml:name> <maml:description> <maml:para>Identifiers of the service instances of the task template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="31"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="32"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="33"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description that needs to be copied to the Subject field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="34"> <maml:name>SupplierId</maml:name> <maml:description> <maml:para>Identifier of the supplier organization that should be selected in the Supplier field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="35"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team that should be selected in the Team field of a new task when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="36"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="37"> <maml:name>Urgent</maml:name> <maml:description> <maml:para>Whether a new task that is created based on the template is to be marked as urgent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="38"> <maml:name>WorkHoursAre24x7</maml:name> <maml:description> <maml:para>Whether the completion target of tasks created based on the template are calculated using a 24x7 calendar rather than normal business hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="39"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of task template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TaskTemplateField[]</command:parameterValue> <dev:type> <maml:name>TaskTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="40"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskCategory</maml:name> </dev:type> <maml:description> <maml:para>A task category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskImpact</maml:name> </dev:type> <maml:description> <maml:para>A task impact object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateApprovalInput[]</maml:name> </dev:type> <maml:description> <maml:para>A task template approval input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TaskTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The task template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TaskTemplate</maml:name> </dev:type> <maml:description> <maml:para>A task template object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentTeam</command:name> <command:verb>Set</command:verb> <command:noun>XurrentTeam</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a team.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a team using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentTeam</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>Used to automatically link records to the agile board when they are assigned to the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AutoAssign</maml:name> <maml:description> <maml:para>Whether requests are auto-assigned to a team member.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationManagerId</maml:name> <maml:description> <maml:para>The person who maintains the information about the configuration items that the team supports.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CoordinatorId</maml:name> <maml:description> <maml:para>The current team coordinator for the team. Only members of the team can be selected in this field.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the team may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>InboundEmailLocalPart</maml:name> <maml:description> <maml:para>Used to specify an email address for the team. When an email is sent to this email address, a new request gets generated and assigned to the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager or supervisor of the team. This person is able to maintain the information about the team. The manager of a team does not need to be a member of the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>MemberIds</maml:name> <maml:description> <maml:para>People that are linked as member to the team.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the team that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected work hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>WorkHoursId</maml:name> <maml:description> <maml:para>The calendar that defines the work hours during which the team is available for work on all types of assignments.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="21"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of team properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamField[]</command:parameterValue> <dev:type> <maml:name>TeamField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AgileBoardId</maml:name> <maml:description> <maml:para>Used to automatically link records to the agile board when they are assigned to the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AutoAssign</maml:name> <maml:description> <maml:para>Whether requests are auto-assigned to a team member.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConfigurationManagerId</maml:name> <maml:description> <maml:para>The person who maintains the information about the configuration items that the team supports.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CoordinatorId</maml:name> <maml:description> <maml:para>The current team coordinator for the team. Only members of the team can be selected in this field.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the team may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>InboundEmailLocalPart</maml:name> <maml:description> <maml:para>Used to specify an email address for the team. When an email is sent to this email address, a new request gets generated and assigned to the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>The manager or supervisor of the team. This person is able to maintain the information about the team. The manager of a team does not need to be a member of the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>MemberIds</maml:name> <maml:description> <maml:para>People that are linked as member to the team.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the team.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PictureUri</maml:name> <maml:description> <maml:para>The hyperlink to the image file for the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Remarks</maml:name> <maml:description> <maml:para>Any additional information about the team that might prove useful.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RemarksAttachments</maml:name> <maml:description> <maml:para>The attachments used in the remarks field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>The time zone that applies to the selected work hours.The complete list is available on the Xurrent developer site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>WorkHoursId</maml:name> <maml:description> <maml:para>The calendar that defines the work hours during which the team is available for work on all types of assignments.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="21"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of team properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamField[]</command:parameterValue> <dev:type> <maml:name>TeamField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TeamField[]</maml:name> </dev:type> <maml:description> <maml:para>The team field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Team</maml:name> </dev:type> <maml:description> <maml:para>A team object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentTimeAllocation</command:name> <command:verb>Set</command:verb> <command:noun>XurrentTimeAllocation</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a time allocation.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a time allocation using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentTimeAllocation</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomerCategory</maml:name> <maml:description> <maml:para>Whether a person who spent on the time allocation needs to select a customer organization, and if this is the case, whether this person may only select from the customer organizations linked to the time allocation or is allowed to select any customer organization.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationCustomerCategory</command:parameterValue> <dev:type> <maml:name>TimeAllocationCustomerCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerIds</maml:name> <maml:description> <maml:para>Identifiers of the customer organizations of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>DescriptionCategory</maml:name> <maml:description> <maml:para>Whether the Description field should be available, and if so, whether it should be required, in the time entries to which the time allocation is related.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationDescriptionCategory</command:parameterValue> <dev:type> <maml:name>TimeAllocationDescriptionCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the time allocation may no longer be related to any more organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on this time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Group</maml:name> <maml:description> <maml:para>Which group to include the time allocation in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of the organizations of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServiceCategory</maml:name> <maml:description> <maml:para>Whether a Person who spent on the time allocation needs to select a service, and if this is the case, whether this person may only select from the services linked to the time allocation or is allowed to select any service.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationServiceCategory</command:parameterValue> <dev:type> <maml:name>TimeAllocationServiceCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ServiceIds</maml:name> <maml:description> <maml:para>Identifiers of the services of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="14"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of time allocation properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimeAllocationField[]</command:parameterValue> <dev:type> <maml:name>TimeAllocationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CustomerCategory</maml:name> <maml:description> <maml:para>Whether a person who spent on the time allocation needs to select a customer organization, and if this is the case, whether this person may only select from the customer organizations linked to the time allocation or is allowed to select any customer organization.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationCustomerCategory</command:parameterValue> <dev:type> <maml:name>TimeAllocationCustomerCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerIds</maml:name> <maml:description> <maml:para>Identifiers of the customer organizations of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>DescriptionCategory</maml:name> <maml:description> <maml:para>Whether the Description field should be available, and if so, whether it should be required, in the time entries to which the time allocation is related.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationDescriptionCategory</command:parameterValue> <dev:type> <maml:name>TimeAllocationDescriptionCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the time allocation may no longer be related to any more organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone registers time on this time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Group</maml:name> <maml:description> <maml:para>Which group to include the time allocation in.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of the organizations of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServiceCategory</maml:name> <maml:description> <maml:para>Whether a Person who spent on the time allocation needs to select a service, and if this is the case, whether this person may only select from the services linked to the time allocation or is allowed to select any service.</maml:para> </maml:description> <command:parameterValue required="false">TimeAllocationServiceCategory</command:parameterValue> <dev:type> <maml:name>TimeAllocationServiceCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ServiceIds</maml:name> <maml:description> <maml:para>Identifiers of the services of the time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="14"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of time allocation properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimeAllocationField[]</command:parameterValue> <dev:type> <maml:name>TimeAllocationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationCustomerCategory</maml:name> </dev:type> <maml:description> <maml:para>A time allocation customer category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationDescriptionCategory</maml:name> </dev:type> <maml:description> <maml:para>A time allocation description category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationServiceCategory</maml:name> </dev:type> <maml:description> <maml:para>A time allocation service category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeAllocationField[]</maml:name> </dev:type> <maml:description> <maml:para>The time allocation field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TimeAllocation</maml:name> </dev:type> <maml:description> <maml:para>A time allocation object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentTimeEntry</command:name> <command:verb>Set</command:verb> <command:noun>XurrentTimeEntry</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a time entry.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a time entry using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentTimeEntry</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Correction</maml:name> <maml:description> <maml:para>Whether the time entry should be considered a correction for a time entry that was registered for a date that has already been locked.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization for which the time was spent.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Date</maml:name> <maml:description> <maml:para>The date on which the time was spent.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Automatically checked after the time entry has been deleted. The data of a deleted time entry that is older than 3 months can no longer be retrieved.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>A short description of the time spent. This field is available and required only when the Description required box is checked in the selected time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>NoteId</maml:name> <maml:description> <maml:para>Identifier of the note the time entry is linked to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>Identifier of the organization to which the person was linked when the time entry was created.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person who spent the time.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the time was spent.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>StartedAt</maml:name> <maml:description> <maml:para>The start time of the work.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team the person of the time entry was a member of while the work was performed.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>TimeAllocationId</maml:name> <maml:description> <maml:para>Identifier of the time allocation on which the time was spent. Only the time allocations that are linked to the person’s organization can be selected.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The number of minutes that was spent on the selected time allocation. The number of minutes is allowed to be negative only when the correction field is set to true.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="18"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of time entry properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimeEntryField[]</command:parameterValue> <dev:type> <maml:name>TimeEntryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Correction</maml:name> <maml:description> <maml:para>Whether the time entry should be considered a correction for a time entry that was registered for a date that has already been locked.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CustomerId</maml:name> <maml:description> <maml:para>Identifier of the organization for which the time was spent.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Date</maml:name> <maml:description> <maml:para>The date on which the time was spent.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Deleted</maml:name> <maml:description> <maml:para>Automatically checked after the time entry has been deleted. The data of a deleted time entry that is older than 3 months can no longer be retrieved.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>A short description of the time spent. This field is available and required only when the Description required box is checked in the selected time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that best reflects the type of effort for which time spent is being registered.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>NoteId</maml:name> <maml:description> <maml:para>Identifier of the note the time entry is linked to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>Identifier of the organization to which the person was linked when the time entry was created.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>PersonId</maml:name> <maml:description> <maml:para>Identifier of the person who spent the time.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>Identifier of the service for which the time was spent.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>StartedAt</maml:name> <maml:description> <maml:para>The start time of the work.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>Identifier of the team the person of the time entry was a member of while the work was performed.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>TimeAllocationId</maml:name> <maml:description> <maml:para>Identifier of the time allocation on which the time was spent. Only the time allocations that are linked to the person’s organization can be selected.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>TimeSpent</maml:name> <maml:description> <maml:para>The number of minutes that was spent on the selected time allocation. The number of minutes is allowed to be negative only when the correction field is set to true.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="18"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of time entry properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimeEntryField[]</command:parameterValue> <dev:type> <maml:name>TimeEntryField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimeEntryField[]</maml:name> </dev:type> <maml:description> <maml:para>The time entry field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TimeEntry</maml:name> </dev:type> <maml:description> <maml:para>A time entry object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentTimesheetSetting</command:name> <command:verb>Set</command:verb> <command:noun>XurrentTimesheetSetting</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a timesheet setting.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a timesheet setting using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentTimesheetSetting</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AllocationTimeTracking</maml:name> <maml:description> <maml:para>Whether people of the related organizations need to be able to register time entries for the time allocations that are linked to their organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AllowWorkdayOvertime</maml:name> <maml:description> <maml:para>Whether the people of the organizations to which the timesheet settings are linked are allowed to register more time for a single day than the amount of time specified in the Workday field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AllowWorkweekOvertime</maml:name> <maml:description> <maml:para>Whether the people of the organizations to which the timesheet settings are linked are allowed to register more time for a single week than the amount of time specified in the Workweek field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AssignmentTimeTracking</maml:name> <maml:description> <maml:para>Whether the Time spent field needs to be available in requests, problems and tasks for specialists of the related organizations to specify how long they have worked on their assignments.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the timesheet settings may no longer be related to any more organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClassIds</maml:name> <maml:description> <maml:para>Identifiers of effort classes of the timesheet setting.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the timesheet settings.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>NotifyOnIncomplete</maml:name> <maml:description> <maml:para>Whether an email notification should be sent to each person who registered fewer hours for the past week than the workweek hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of organizations of the timesheet setting.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>PercentageIncrement</maml:name> <maml:description> <maml:para>The minimum amount percentage of a workday that the people of the organizations to which the timesheet settings are linked can select when they register a time entry. This percentage of a workday is also the increment by which they can increase this minimum percentage of a workday.</maml:para> </maml:description> <command:parameterValue required="false">TimesheetSettingPercentageIncrement</command:parameterValue> <dev:type> <maml:name>TimesheetSettingPercentageIncrement</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ProblemEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ProjectTaskEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RequestEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RequireNote</maml:name> <maml:description> <maml:para>Whether the Note field needs to become required, when someone in an organization linked to the timesheet settings registers time on a request, problem or task.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>TaskEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a workflow task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>TimeAllocationEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TimeIncrement</maml:name> <maml:description> <maml:para>The minimum amount of time that the people of the organizations to which the timesheet settings are linked can select when they register a time entry. This amount of time is also the increment by which they can increase this minimum amount of time.</maml:para> </maml:description> <command:parameterValue required="false">TimesheetSettingTimeIncrement</command:parameterValue> <dev:type> <maml:name>TimesheetSettingTimeIncrement</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Unit</maml:name> <maml:description> <maml:para>Whether the people of the organizations to which the timesheet settings are linked need to register their time in hours and minutes, or as a percentage of a workday.</maml:para> </maml:description> <command:parameterValue required="false">TimesheetSettingUnit</command:parameterValue> <dev:type> <maml:name>TimesheetSettingUnit</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Workday</maml:name> <maml:description> <maml:para>The duration of a workday in minutes.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Workweek</maml:name> <maml:description> <maml:para>The duration of a workweek in minutes.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="24"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of timesheet setting properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimesheetSettingField[]</command:parameterValue> <dev:type> <maml:name>TimesheetSettingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AllocationTimeTracking</maml:name> <maml:description> <maml:para>Whether people of the related organizations need to be able to register time entries for the time allocations that are linked to their organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>AllowWorkdayOvertime</maml:name> <maml:description> <maml:para>Whether the people of the organizations to which the timesheet settings are linked are allowed to register more time for a single day than the amount of time specified in the Workday field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>AllowWorkweekOvertime</maml:name> <maml:description> <maml:para>Whether the people of the organizations to which the timesheet settings are linked are allowed to register more time for a single week than the amount of time specified in the Workweek field.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>AssignmentTimeTracking</maml:name> <maml:description> <maml:para>Whether the Time spent field needs to be available in requests, problems and tasks for specialists of the related organizations to specify how long they have worked on their assignments.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the timesheet settings may no longer be related to any more organizations.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>EffortClassIds</maml:name> <maml:description> <maml:para>Identifiers of effort classes of the timesheet setting.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the timesheet settings.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>NotifyOnIncomplete</maml:name> <maml:description> <maml:para>Whether an email notification should be sent to each person who registered fewer hours for the past week than the workweek hours.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>OrganizationIds</maml:name> <maml:description> <maml:para>Identifiers of organizations of the timesheet setting.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>PercentageIncrement</maml:name> <maml:description> <maml:para>The minimum amount percentage of a workday that the people of the organizations to which the timesheet settings are linked can select when they register a time entry. This percentage of a workday is also the increment by which they can increase this minimum percentage of a workday.</maml:para> </maml:description> <command:parameterValue required="false">TimesheetSettingPercentageIncrement</command:parameterValue> <dev:type> <maml:name>TimesheetSettingPercentageIncrement</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ProblemEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a problem.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ProjectTaskEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a project task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>RequestEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a request.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>RequireNote</maml:name> <maml:description> <maml:para>Whether the Note field needs to become required, when someone in an organization linked to the timesheet settings registers time on a request, problem or task.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>TaskEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a workflow task.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>TimeAllocationEffortClassId</maml:name> <maml:description> <maml:para>Identifier of the effort class that is selected by default, when someone in an organization linked to the timesheet settings registers time on a time allocation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>TimeIncrement</maml:name> <maml:description> <maml:para>The minimum amount of time that the people of the organizations to which the timesheet settings are linked can select when they register a time entry. This amount of time is also the increment by which they can increase this minimum amount of time.</maml:para> </maml:description> <command:parameterValue required="false">TimesheetSettingTimeIncrement</command:parameterValue> <dev:type> <maml:name>TimesheetSettingTimeIncrement</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>Unit</maml:name> <maml:description> <maml:para>Whether the people of the organizations to which the timesheet settings are linked need to register their time in hours and minutes, or as a percentage of a workday.</maml:para> </maml:description> <command:parameterValue required="false">TimesheetSettingUnit</command:parameterValue> <dev:type> <maml:name>TimesheetSettingUnit</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Workday</maml:name> <maml:description> <maml:para>The duration of a workday in minutes.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>Workweek</maml:name> <maml:description> <maml:para>The duration of a workweek in minutes.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="24"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of timesheet setting properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TimesheetSettingField[]</command:parameterValue> <dev:type> <maml:name>TimesheetSettingField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimesheetSettingPercentageIncrement</maml:name> </dev:type> <maml:description> <maml:para>A timesheet setting percentage increment object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimesheetSettingTimeIncrement</maml:name> </dev:type> <maml:description> <maml:para>A timesheet setting time increment object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimesheetSettingUnit</maml:name> </dev:type> <maml:description> <maml:para>A timesheet setting unit object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TimesheetSettingField[]</maml:name> </dev:type> <maml:description> <maml:para>The timesheet setting field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TimesheetSetting</maml:name> </dev:type> <maml:description> <maml:para>A timesheet setting object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentTranslation</command:name> <command:verb>Set</command:verb> <command:noun>XurrentTranslation</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a translation.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a translation using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentTranslation</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Text</maml:name> <maml:description> <maml:para>The text of the translation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of translation properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TranslationField[]</command:parameterValue> <dev:type> <maml:name>TranslationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Text</maml:name> <maml:description> <maml:para>The text of the translation.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of translation properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TranslationField[]</command:parameterValue> <dev:type> <maml:name>TranslationField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.TranslationField[]</maml:name> </dev:type> <maml:description> <maml:para>The translation field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Translation</maml:name> </dev:type> <maml:description> <maml:para>A translation object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentUiExtension</command:name> <command:verb>Set</command:verb> <command:noun>XurrentUiExtension</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating an user interface extension.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates an user interface extension using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentUiExtension</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Activate</maml:name> <maml:description> <maml:para>Set to true to promote the Prepared Version to the Active Version. If the was an Active Version, it will be Archived.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Css</maml:name> <maml:description> <maml:para>Sets the CSS stylesheet of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the UI extension.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the UI extension is inactive.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>FormDefinition</maml:name> <maml:description> <maml:para>Sets the Form Definition of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">JToken</command:parameterValue> <dev:type> <maml:name>JToken</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Html</maml:name> <maml:description> <maml:para>Sets the HTML code of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Javascript</maml:name> <maml:description> <maml:para>Sets the Javascript code of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the UI extension.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Title</maml:name> <maml:description> <maml:para>The text that is to be displayed as the section header above the UI extension when the UI extension is presented within a form.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="14"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of user interface extension properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UiExtensionField[]</command:parameterValue> <dev:type> <maml:name>UiExtensionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Activate</maml:name> <maml:description> <maml:para>Set to true to promote the Prepared Version to the Active Version. If the was an Active Version, it will be Archived.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Css</maml:name> <maml:description> <maml:para>Sets the CSS stylesheet of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the UI extension.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the UI extension is inactive.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>FormDefinition</maml:name> <maml:description> <maml:para>Sets the Form Definition of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">JToken</command:parameterValue> <dev:type> <maml:name>JToken</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Html</maml:name> <maml:description> <maml:para>Sets the HTML code of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Javascript</maml:name> <maml:description> <maml:para>Sets the Javascript code of the Prepared Version if updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the UI extension.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>Title</maml:name> <maml:description> <maml:para>The text that is to be displayed as the section header above the UI extension when the UI extension is presented within a form.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="14"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of user interface extension properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UiExtensionField[]</command:parameterValue> <dev:type> <maml:name>UiExtensionField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Newtonsoft.Json.Linq.JToken</maml:name> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.UiExtensionField[]</maml:name> </dev:type> <maml:description> <maml:para>The user interface extension field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>UiExtension</maml:name> </dev:type> <maml:description> <maml:para>An user interface extension object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentWaitingForCustomerFollowUp</command:name> <command:verb>Set</command:verb> <command:noun>XurrentWaitingForCustomerFollowUp</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a waiting for customer follow up.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a waiting for customer follow up using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentWaitingForCustomerFollowUp</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AutoComplete</maml:name> <maml:description> <maml:para>Auto-complete when the final waiting for customer notification is sent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the waiting for customer follow-up may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the waiting for customer follow-up.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>NewWaitingForCustomerRules</maml:name> <maml:description> <maml:para>Rules of this waiting for customer follow-up.</maml:para> </maml:description> <command:parameterValue required="false">WaitingForCustomerRuleInput[]</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerRuleInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>WaitingForCustomerRulesToDelete</maml:name> <maml:description> <maml:para>Identifiers of rules to remove from the waiting for customer follow-up.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of waiting for customer follow up properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WaitingForCustomerFollowUpField[]</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerFollowUpField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>AutoComplete</maml:name> <maml:description> <maml:para>Auto-complete when the final waiting for customer notification is sent.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the waiting for customer follow-up may no longer be related to other records.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the waiting for customer follow-up.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>NewWaitingForCustomerRules</maml:name> <maml:description> <maml:para>Rules of this waiting for customer follow-up.</maml:para> </maml:description> <command:parameterValue required="false">WaitingForCustomerRuleInput[]</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerRuleInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>WaitingForCustomerRulesToDelete</maml:name> <maml:description> <maml:para>Identifiers of rules to remove from the waiting for customer follow-up.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of waiting for customer follow up properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WaitingForCustomerFollowUpField[]</command:parameterValue> <dev:type> <maml:name>WaitingForCustomerFollowUpField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WaitingForCustomerRuleInput[]</maml:name> </dev:type> <maml:description> <maml:para>A waiting for customer rule input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WaitingForCustomerFollowUpField[]</maml:name> </dev:type> <maml:description> <maml:para>The waiting for customer follow up field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WaitingForCustomerFollowUp</maml:name> </dev:type> <maml:description> <maml:para>A waiting for customer follow up object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentWebhook</command:name> <command:verb>Set</command:verb> <command:noun>XurrentWebhook</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a webhook.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a webhook using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentWebhook</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the webhook's purpose.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the webhook will be triggered when the event occurs.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Event</maml:name> <maml:description> <maml:para>Event that will trigger this webhook.</maml:para> </maml:description> <command:parameterValue required="false">WebhookEvent</command:parameterValue> <dev:type> <maml:name>WebhookEvent</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MailExceptionsTo</maml:name> <maml:description> <maml:para>Comma separated list of email addresses who will be informed when the webhook execution fails.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of this webhook. Defaults to the event name.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Publicly accessible URI that Xurrent can use to POST http messages to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>WebhookPolicyId</maml:name> <maml:description> <maml:para>The webhook policy to use for cryptographic signing of the messages.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of webhook properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookField[]</command:parameterValue> <dev:type> <maml:name>WebhookField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the webhook's purpose.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DescriptionAttachments</maml:name> <maml:description> <maml:para>The attachments used in the description field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the webhook will be triggered when the event occurs.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Event</maml:name> <maml:description> <maml:para>Event that will trigger this webhook.</maml:para> </maml:description> <command:parameterValue required="false">WebhookEvent</command:parameterValue> <dev:type> <maml:name>WebhookEvent</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MailExceptionsTo</maml:name> <maml:description> <maml:para>Comma separated list of email addresses who will be informed when the webhook execution fails.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of this webhook. Defaults to the event name.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Publicly accessible URI that Xurrent can use to POST http messages to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>WebhookPolicyId</maml:name> <maml:description> <maml:para>The webhook policy to use for cryptographic signing of the messages.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of webhook properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookField[]</command:parameterValue> <dev:type> <maml:name>WebhookField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookEvent</maml:name> </dev:type> <maml:description> <maml:para>A webhook event object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookField[]</maml:name> </dev:type> <maml:description> <maml:para>The webhook field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Webhook</maml:name> </dev:type> <maml:description> <maml:para>A webhook object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentWebhookPolicy</command:name> <command:verb>Set</command:verb> <command:noun>XurrentWebhookPolicy</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a webhook policy.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a webhook policy using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentWebhookPolicy</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the webhook policy will be applied.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>JwtAlg</maml:name> <maml:description> <maml:para>The algorithm to use for cryptographic signing of webhook messages.</maml:para> </maml:description> <command:parameterValue required="false">WebhookPolicyJwtAlg</command:parameterValue> <dev:type> <maml:name>WebhookPolicyJwtAlg</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>JwtAudience</maml:name> <maml:description> <maml:para>The audience claim identifies the recipients that the encrypted message is intended for.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>JwtClaimExpiresIn</maml:name> <maml:description> <maml:para>The number of minutes within which the claim expires.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="6"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of webhook policy properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookPolicyField[]</command:parameterValue> <dev:type> <maml:name>WebhookPolicyField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the webhook policy will be applied.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>JwtAlg</maml:name> <maml:description> <maml:para>The algorithm to use for cryptographic signing of webhook messages.</maml:para> </maml:description> <command:parameterValue required="false">WebhookPolicyJwtAlg</command:parameterValue> <dev:type> <maml:name>WebhookPolicyJwtAlg</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>JwtAudience</maml:name> <maml:description> <maml:para>The audience claim identifies the recipients that the encrypted message is intended for.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>JwtClaimExpiresIn</maml:name> <maml:description> <maml:para>The number of minutes within which the claim expires.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="6"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of webhook policy properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WebhookPolicyField[]</command:parameterValue> <dev:type> <maml:name>WebhookPolicyField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookPolicyJwtAlg</maml:name> </dev:type> <maml:description> <maml:para>A webhook policy JSON web token alg object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WebhookPolicyField[]</maml:name> </dev:type> <maml:description> <maml:para>The webhook policy field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WebhookPolicy</maml:name> </dev:type> <maml:description> <maml:para>A webhook policy object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentWorkflow</command:name> <command:verb>Set</command:verb> <command:noun>XurrentWorkflow</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a workflow.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a workflow using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentWorkflow</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the workflow.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowCategory</command:parameterValue> <dev:type> <maml:name>WorkflowCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>Used to select the appropriate completion reason for the workflow when it has been completed. It is automatically set to "Complete" when all tasks related to the workflow have reached the status "Completed", "Approved" or "Canceled".</maml:para> </maml:description> <command:parameterValue required="false">WorkflowCompletionReason</command:parameterValue> <dev:type> <maml:name>WorkflowCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Justification</maml:name> <maml:description> <maml:para>The reason why the change was requested.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowJustification</command:parameterValue> <dev:type> <maml:name>WorkflowJustification</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Who is responsible for coordinating the implementation of the workflow. If a manager is not specified for a new workflow, the API user is selected in the Manager field by default.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Note</maml:name> <maml:description> <maml:para>High-level description of the result that should be accomplished by the implementation of the workflow. It is also used to add any information that could prove useful for anyone affected by the workflow, including the people whose approval is needed and the specialists who are helping to implement it.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ProblemIds</maml:name> <maml:description> <maml:para>Identifiers of all problems linked of this workflow.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>Linked project</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ReleaseId</maml:name> <maml:description> <maml:para>The release that the workflow is a part of.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>RequestIds</maml:name> <maml:description> <maml:para>Identifiers of all requests linked to this workflow.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>The service that will directly be affected by the workflow implementation, or in case of an emergency change, the service that was directly affected by the workflow implementation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The date and time at which the Status field of the first tasks of the workflow will automatically be set to "Assigned".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Status</maml:name> <maml:description> <maml:para>Automatically set based on the status of the workflow's tasks.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowStatus</command:parameterValue> <dev:type> <maml:name>WorkflowStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>The workflow template that was used to register the workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>WorkflowType</maml:name> <maml:description> <maml:para>Used to indicate whether the workflow needs to be implemented following the procedure steps for application changes or for infrastructure changes.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="21"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of workflow properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowField[]</command:parameterValue> <dev:type> <maml:name>WorkflowField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category of the workflow.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowCategory</command:parameterValue> <dev:type> <maml:name>WorkflowCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CompletionReason</maml:name> <maml:description> <maml:para>Used to select the appropriate completion reason for the workflow when it has been completed. It is automatically set to "Complete" when all tasks related to the workflow have reached the status "Completed", "Approved" or "Canceled".</maml:para> </maml:description> <command:parameterValue required="false">WorkflowCompletionReason</command:parameterValue> <dev:type> <maml:name>WorkflowCompletionReason</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>CustomFields</maml:name> <maml:description> <maml:para>Values for custom fields to be used by the UI Extension that is linked to the record.</maml:para> </maml:description> <command:parameterValue required="false">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>CustomFieldsAttachments</maml:name> <maml:description> <maml:para>The attachments used in the custom fields' values.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Justification</maml:name> <maml:description> <maml:para>The reason why the change was requested.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowJustification</command:parameterValue> <dev:type> <maml:name>WorkflowJustification</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>Who is responsible for coordinating the implementation of the workflow. If a manager is not specified for a new workflow, the API user is selected in the Manager field by default.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Note</maml:name> <maml:description> <maml:para>High-level description of the result that should be accomplished by the implementation of the workflow. It is also used to add any information that could prove useful for anyone affected by the workflow, including the people whose approval is needed and the specialists who are helping to implement it.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ProblemIds</maml:name> <maml:description> <maml:para>Identifiers of all problems linked of this workflow.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>Linked project</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ReleaseId</maml:name> <maml:description> <maml:para>The release that the workflow is a part of.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>RequestIds</maml:name> <maml:description> <maml:para>Identifiers of all requests linked to this workflow.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>The service that will directly be affected by the workflow implementation, or in case of an emergency change, the service that was directly affected by the workflow implementation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>The date and time at which the Status field of the first tasks of the workflow will automatically be set to "Assigned".</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>Status</maml:name> <maml:description> <maml:para>Automatically set based on the status of the workflow's tasks.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowStatus</command:parameterValue> <dev:type> <maml:name>WorkflowStatus</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Subject</maml:name> <maml:description> <maml:para>A short description of the objective of the workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>The workflow template that was used to register the workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>WorkflowType</maml:name> <maml:description> <maml:para>Used to indicate whether the workflow needs to be implemented following the procedure steps for application changes or for infrastructure changes.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="21"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of workflow properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowField[]</command:parameterValue> <dev:type> <maml:name>WorkflowField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowCategory</maml:name> </dev:type> <maml:description> <maml:para>A workflow category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowCompletionReason</maml:name> </dev:type> <maml:description> <maml:para>A workflow completion reason object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>A custom field collection object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowJustification</maml:name> </dev:type> <maml:description> <maml:para>A workflow justification object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowStatus</maml:name> </dev:type> <maml:description> <maml:para>A workflow status object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowField[]</maml:name> </dev:type> <maml:description> <maml:para>The workflow field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Workflow</maml:name> </dev:type> <maml:description> <maml:para>A workflow object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentWorkflowTemplate</command:name> <command:verb>Set</command:verb> <command:noun>XurrentWorkflowTemplate</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a workflow template.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a workflow template using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentWorkflowTemplate</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowCategory</command:parameterValue> <dev:type> <maml:name>WorkflowCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the workflow template may not be used to help register new workflows.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>The information that needs to be shown when a new workflow is being created based on the template. This field typically contains instructions about how to register the workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Justification</maml:name> <maml:description> <maml:para>The justification that needs to be selected in the Justification field of a new workflow when it is being created based on the template. This field is required when there are request templates linked to the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowJustification</command:parameterValue> <dev:type> <maml:name>WorkflowJustification</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>NewTaskTemplateRelations</maml:name> <maml:description> <maml:para>Task template relations of the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateTaskTemplateInput[]</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateTaskTemplateInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceInput</command:parameterValue> <dev:type> <maml:name>RecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>The service that should be selected in the Service field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Short description that needs to be copied to the Subject field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>TaskTemplateRelationsToDelete</maml:name> <maml:description> <maml:para>Identifiers of task template relations to remove from the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>The person who will be responsible for coordinating the workflows that will be generated automatically in accordance with the recurrence schedule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>WorkflowTypeId</maml:name> <maml:description> <maml:para>The type that needs to be selected in the Type field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="17"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of workflow template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTemplateField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Category</maml:name> <maml:description> <maml:para>The category that needs to be selected in the Category field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowCategory</command:parameterValue> <dev:type> <maml:name>WorkflowCategory</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the workflow template may not be used to help register new workflows.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Instructions</maml:name> <maml:description> <maml:para>The information that needs to be shown when a new workflow is being created based on the template. This field typically contains instructions about how to register the workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Justification</maml:name> <maml:description> <maml:para>The justification that needs to be selected in the Justification field of a new workflow when it is being created based on the template. This field is required when there are request templates linked to the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowJustification</command:parameterValue> <dev:type> <maml:name>WorkflowJustification</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>NewTaskTemplateRelations</maml:name> <maml:description> <maml:para>Task template relations of the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">WorkflowTemplateTaskTemplateInput[]</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateTaskTemplateInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Note</maml:name> <maml:description> <maml:para>The information that needs to be copied to the Note field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Recurrence</maml:name> <maml:description> <maml:para>Recurrence for the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">RecurrenceInput</command:parameterValue> <dev:type> <maml:name>RecurrenceInput</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServiceId</maml:name> <maml:description> <maml:para>The service that should be selected in the Service field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Short description that needs to be copied to the Subject field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>TaskTemplateRelationsToDelete</maml:name> <maml:description> <maml:para>Identifiers of task template relations to remove from the workflow template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>UiExtensionId</maml:name> <maml:description> <maml:para>UI extension that is to be applied to the record.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>WorkflowManagerId</maml:name> <maml:description> <maml:para>The person who will be responsible for coordinating the workflows that will be generated automatically in accordance with the recurrence schedule.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>WorkflowTypeId</maml:name> <maml:description> <maml:para>The type that needs to be selected in the Type field of a new workflow when it is being created based on the template.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="17"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of workflow template properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTemplateField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTemplateField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowCategory</maml:name> </dev:type> <maml:description> <maml:para>A workflow category object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowJustification</maml:name> </dev:type> <maml:description> <maml:para>A workflow justification object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateTaskTemplateInput[]</maml:name> </dev:type> <maml:description> <maml:para>A workflow template task template input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.RecurrenceInput</maml:name> </dev:type> <maml:description> <maml:para>A recurrence input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTemplateField[]</maml:name> </dev:type> <maml:description> <maml:para>The workflow template field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WorkflowTemplate</maml:name> </dev:type> <maml:description> <maml:para>A workflow template object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-XurrentWorkflowType</command:name> <command:verb>Set</command:verb> <command:noun>XurrentWorkflowType</command:noun> <command:description> <maml:para>A PowerShell cmdlet for updating a workflow type.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>Updates a workflow type using the provided parameters.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Set-XurrentWorkflowType</maml:name> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Very short description of the workflow type, for example "More than 200 workdays or $200K".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the workflow type may not be related to any more workflows.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the workflow type that might prove useful, especially for workflow managers when they need to decide which workflow type to select for a workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the workflow type. Ideally the name of a workflow type consists of a single word, such as "Large".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the workflow type takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of workflow type properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTypeField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTypeField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The node ID of the record to update.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClientMutationId</maml:name> <maml:description> <maml:para>A unique identifier for the client performing the mutation.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Very short description of the workflow type, for example "More than 200 workdays or $200K".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Whether the workflow type may not be related to any more workflows.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Information</maml:name> <maml:description> <maml:para>Any additional information about the workflow type that might prove useful, especially for workflow managers when they need to decide which workflow type to select for a workflow.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>InformationAttachments</maml:name> <maml:description> <maml:para>The attachments used in the information field.</maml:para> </maml:description> <command:parameterValue required="false">AttachmentInput[]</command:parameterValue> <dev:type> <maml:name>AttachmentInput[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the workflow type. Ideally the name of a workflow type consists of a single word, such as "Large".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position that the workflow type takes when it is displayed in a sorted list.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Source</maml:name> <maml:description> <maml:para>An identifier for the client application submitting the resource or the name of an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>The unique identifier of the resource in an external system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>Properties</maml:name> <maml:description> <maml:para>An array of workflow type properties to include in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">WorkflowTypeField[]</command:parameterValue> <dev:type> <maml:name>WorkflowTypeField[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>Client</maml:name> <maml:description> <maml:para>The client used to execute the update mutation. If no client is specified, the first created client will be used by default.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.boolean</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.AttachmentInput[]</maml:name> </dev:type> <maml:description> <maml:para>An attachment input object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int64</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.WorkflowTypeField[]</maml:name> </dev:type> <maml:description> <maml:para>The workflow type field enumerator.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>WorkflowType</maml:name> </dev:type> <maml:description> <maml:para>A workflow type object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-XurrentCustomFields</command:name> <command:verb>Show</command:verb> <command:noun>XurrentCustomFields</command:noun> <command:description> <maml:para>A PowerShell cmdlet to add or update a custom field value. If the custom field identifier already exists, it will be assigned a new value; otherwise, it gets created.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Show-XurrentCustomFields cmdlet adds or updates a custom field value.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Show-XurrentCustomFields</maml:name> <command:parameter required="true" position="0"> <maml:name>CustomFieldCollection</maml:name> <maml:description> <maml:para>The custom field collection to show.</maml:para> </maml:description> <command:parameterValue required="true">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>CustomFieldCollection</maml:name> <maml:description> <maml:para>The custom field collection to show.</maml:para> </maml:description> <command:parameterValue required="true">CustomFieldCollection</command:parameterValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>The Custom field collection.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomFieldCollection</maml:name> </dev:type> <maml:description> <maml:para>The Custom Field Collection with the new or updated item.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-XurrentDataExport</command:name> <command:verb>Start</command:verb> <command:noun>XurrentDataExport</command:noun> <command:description> <maml:para>A PowerShell cmdlet to export data from the Xurrent system in different formats, such as CSV and Excel.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Start-XurrentDataExport cmdlet exports data from the Xurrent system in the specified format. Supported formats include CSV and Excel.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Start-XurrentDataExport</maml:name> <command:parameter required="true" position="0"> <maml:name>Format</maml:name> <maml:description> <maml:para>Specifies the export format.</maml:para> </maml:description> <command:parameterValue required="true">DataExportFormat</command:parameterValue> <dev:type> <maml:name>DataExportFormat</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>LineSeparator</maml:name> <maml:description> <maml:para>Specifies the line separator for CSV exports.</maml:para> </maml:description> <command:parameterValue required="false">ExportLineSeparator</command:parameterValue> <dev:type> <maml:name>ExportLineSeparator</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Types</maml:name> <maml:description> <maml:para>Specifies the types of data to export.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>From</maml:name> <maml:description> <maml:para>Specifies the start date for the export.</maml:para> </maml:description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Client</maml:name> <maml:description> <maml:para>Specifies the Xurrent PowerShell client instance.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Format</maml:name> <maml:description> <maml:para>Specifies the export format.</maml:para> </maml:description> <command:parameterValue required="true">DataExportFormat</command:parameterValue> <dev:type> <maml:name>DataExportFormat</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>LineSeparator</maml:name> <maml:description> <maml:para>Specifies the line separator for CSV exports.</maml:para> </maml:description> <command:parameterValue required="false">ExportLineSeparator</command:parameterValue> <dev:type> <maml:name>ExportLineSeparator</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Types</maml:name> <maml:description> <maml:para>Specifies the types of data to export.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>From</maml:name> <maml:description> <maml:para>Specifies the start date for the export.</maml:para> </maml:description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Client</maml:name> <maml:description> <maml:para>Specifies the Xurrent PowerShell client instance.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.datetime</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>The unique token identifying the export operation.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-XurrentDataImport</command:name> <command:verb>Start</command:verb> <command:noun>XurrentDataImport</command:noun> <command:description> <maml:para>A PowerShell cmdlet to initiate the data import process to the Xurrent system. This CmdLet supports importing data from specified file paths or streams.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Start-XurrentDataImport cmdlet initiates the data import process to the Xurrent system using the specified type and file path. The CmdLet returns an object representing the import operation, which can be used to monitor the status and ensure the data is successfully imported.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Start-XurrentDataImport</maml:name> <command:parameter required="true" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of data to import.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the file path of the data to import.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Client</maml:name> <maml:description> <maml:para>The Xurrent PowerShell client instance.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of data to import.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the file path of the data to import.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Client</maml:name> <maml:description> <maml:para>The Xurrent PowerShell client instance.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>The unique token identifying the import operation.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Wait-XurrentDataImport</command:name> <command:verb>Wait</command:verb> <command:noun>XurrentDataImport</command:noun> <command:description> <maml:para>A PowerShell cmdlet to wait for the data import process to complete by periodically checking the import status.</maml:para> </command:description> <maml:copyright> <maml:para>Copyright (c) 2025 Xurrent Inc.</maml:para> </maml:copyright> </command:details> <command:description> <maml:para>The Wait-XurrentDataImport cmdlet periodically checks the status of a data import process until it completes, using the specified token and polling interval.</maml:para> </command:description> <command:syntax> <command:syntaxItem> <maml:name>Wait-XurrentDataImport</maml:name> <command:parameter required="true" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>The import token.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PollingInterval</maml:name> <maml:description> <maml:para>The interval in seconds to wait between status checks.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The maximum time in seconds to wait for the import to complete.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Client</maml:name> <maml:description> <maml:para>The Xurrent PowerShell client instance.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>The import token.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>PollingInterval</maml:name> <maml:description> <maml:para>The interval in seconds to wait between status checks.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The maximum time in seconds to wait for the import to complete.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Client</maml:name> <maml:description> <maml:para>The Xurrent PowerShell client instance.</maml:para> </maml:description> <command:parameterValue required="false">XurrentPowerShellClient</command:parameterValue> <dev:type> <maml:name>XurrentPowerShellClient</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Xurrent.GraphQL.PowerShell.XurrentPowerShellClient</maml:name> </dev:type> <maml:description> <maml:para>The Xurrent PowerShell client.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.string</maml:uri> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri>https://learn.microsoft.com/dotnet/api/system.int32</maml:uri> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BulkImportResponse</maml:name> </dev:type> <maml:description> <maml:para>The response object representing the status of the import operation.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> </helpItems> |