Add-IvantiNote
SYNOPSIS
Add a note to a business object in Ivanti ITSM.
SYNTAX
ParentRecID (Default)
Add-IvantiNote -parentRecID <String> -noteSubject <String> -noteCategory <String> [-noteBody <String>]
[-timeSpent <Int32>] [<CommonParameters>]
serviceReqNumber
Add-IvantiNote -serviceReqNumber <Int32> -noteSubject <String> -noteCategory <String> [-noteBody <String>]
[-timeSpent <Int32>] [<CommonParameters>]
incidentNumber
Add-IvantiNote -incidentNumber <Int32> -noteSubject <String> -noteCategory <String> [-noteBody <String>]
[-timeSpent <Int32>] [<CommonParameters>]
taskNumber
Add-IvantiNote -taskNumber <Int32> -noteSubject <String> -noteCategory <String> [-noteBody <String>]
[-timeSpent <Int32>] [<CommonParameters>]
problemNumber
Add-IvantiNote -problemNumber <Int32> -noteSubject <String> -noteCategory <String> [-noteBody <String>]
[-timeSpent <Int32>] [<CommonParameters>]
Employee
Add-IvantiNote -Employee <String> -noteSubject <String> -noteCategory <String> [-noteBody <String>]
[-timeSpent <Int32>] [<CommonParameters>]
DESCRIPTION
The `Add-Note` function allows you to add a note to a business object in Ivanti ITSM. You can specify the business object using various parameters such as service request number, incident number, task number, or parent record ID. The function also accepts parameters for the note's subject, category, body, and time spent.
EXAMPLES
EXAMPLE 1
Add-Note -serviceReqNumber 12345 -noteSubject 'Follow-up' -noteCategory 'General' -noteBody 'Follow-up on the service request' -timeSpent 30
Adds a note to the service request with the number 12345.
EXAMPLE 2
Add-Note -incidentNumber 67890 -noteSubject 'Resolution' -noteCategory 'Technical' -noteBody 'Resolved the incident' -timeSpent 45
Adds a note to the incident with the number 67890.
EXAMPLE 3
Add-Note -taskNumber 54321 -noteSubject 'Update' -noteCategory 'Progress' -noteBody 'Updated the task status' -timeSpent 15
Adds a note to the task with the number 54321.
EXAMPLE 4
Add-Note -parentRecID 'abc123' -noteSubject 'Meeting Notes' -noteCategory 'Meeting' -noteBody 'Notes from the meeting' -timeSpent 60
Adds a note to the business object with the record ID 'abc123'.
PARAMETERS
-serviceReqNumber
The service request number of the business object to which the note will be added. 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 to which the note will be added. 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
-taskNumber
The task number of the business object to which the note will be added. This parameter is mandatory when using the 'taskNumber' parameter set.
Type: Int32
Parameter Sets: taskNumber
Aliases: Task
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
-parentRecID
The record ID of the parent business object to which the note will be added. This parameter is mandatory when using the 'ParentRecID' parameter set.
Type: String
Parameter Sets: ParentRecID
Aliases: RecID
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-noteSubject
The subject of the note. This parameter is mandatory.
Type: String
Parameter Sets: (All)
Aliases: Subject
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-noteCategory
The category of the note. This parameter is mandatory.
Type: String
Parameter Sets: (All)
Aliases: Category
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-noteBody
The body of the note. This parameter is optional.
Type: String
Parameter Sets: (All)
Aliases: Body
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-timeSpent
The time spent on the note. The default value is 0.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
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 adding notes to various business objects in Ivanti ITSM.