Get-IvantiNote

SYNOPSIS

Retrieve notes for a specified business object.

SYNTAX

RecID (Default)

Get-IvantiNote -recID <String> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]

taskNumber

Get-IvantiNote -taskNumber <Int32> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]

serviceReqNumber

Get-IvantiNote -serviceReqNumber <Int32> [-status <String>] [-customFields <String>] [-top <Int32>]
 [-allFields] [<CommonParameters>]

incidentNumber

Get-IvantiNote -incidentNumber <Int32> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]

problemNumber

Get-IvantiNote -problemNumber <Int32> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]

Employee

Get-IvantiNote -Employee <String> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]

Subject

Get-IvantiNote -subject <String> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]

Filter

Get-IvantiNote -filter <String> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]

Search

Get-IvantiNote -search <String> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]

DESCRIPTION

The `Get-Note` function allows you to retrieve notes for a specified business object in Ivanti ITSM. You can specify the business object using various parameters such as task number, service request number, incident number, record ID, subject, filter, or search.

EXAMPLES

EXAMPLE 1

Get-Note -taskNumber 12345

Retrieves notes for the task with task number 12345.

EXAMPLE 2

Get-Note -serviceReqNumber 67890

Retrieves notes for the service request with service request number 67890.

EXAMPLE 3

Get-Note -incidentNumber 54321

Retrieves notes for the incident with incident number 54321.

EXAMPLE 4

Get-Note -recID 'abc123'

Retrieves notes for the business object with record ID 'abc123'.

EXAMPLE 5

Get-Note -subject 'Meeting Notes'

Retrieves notes with the subject 'Meeting Notes'.

EXAMPLE 6

Get-Note -filter "CreatedBy eq 'John Doe'"

Retrieves notes created by 'John Doe'.

EXAMPLE 7

Get-Note -search 'urgent'

Retrieves notes containing the search string 'urgent'.

PARAMETERS

-taskNumber

The task number of the business object for which to retrieve notes. This parameter is mandatory when using the 'taskNumber' parameter set.

Type: Int32
Parameter Sets: taskNumber
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-serviceReqNumber

The service request number of the business object for which to retrieve notes. This parameter is mandatory when using the 'serviceReqNumber' parameter set.

Type: Int32
Parameter Sets: serviceReqNumber
Aliases: SR

Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-incidentNumber

The incident number of the business object for which to retrieve notes. This parameter is mandatory when using the 'incidentNumber' parameter set.

Type: Int32
Parameter Sets: incidentNumber
Aliases: Incident

Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-problemNumber

{{ Fill problemNumber Description }}

Type: Int32
Parameter Sets: problemNumber
Aliases: Problem

Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Employee

{{ Fill Employee Description }}

Type: String
Parameter Sets: Employee
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-recID

The record ID of the business object for which to retrieve notes. This parameter is mandatory when using the 'RecID' parameter set.

Type: String
Parameter Sets: RecID
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-subject

The subject of the notes to retrieve. This parameter is mandatory when using the 'Subject' parameter set.

Type: String
Parameter Sets: Subject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-filter

A filter to apply when retrieving notes. This parameter is mandatory when using the 'Filter' parameter set.

Type: String
Parameter Sets: Filter
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-search

A search string to apply when retrieving notes. This parameter is mandatory when using the 'Search' parameter set.

Type: String
Parameter Sets: Search
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-status

The status of the notes to retrieve. Valid values are 'Logged', 'Accepted', 'Waiting', 'Cancelled', and 'Completed'. The default value is 'Active'.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Active
Accept pipeline input: False
Accept wildcard characters: False

-customFields

Custom fields to include in the retrieved notes.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-top

The maximum number of notes to retrieve.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-allFields

A switch to include all fields in the retrieved notes.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

This function is useful for retrieving notes for various business objects in Ivanti ITSM.

RELATED LINKS

https://docs.microsoft.com/en-us/powershell/scripting/overview