Function: event.EditNote

Edits a note attachment of an Event.

Syntax

{
	"method": "event.EditNote",
	"params": {
		"id": "...",
		"attachmentId": "...",
		"text": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<bool> EditNote( AdvGuid id, int attachmentId, AdvString text );
public Task<bool> EditNoteAsync(Guid id, long attachmentId, string text, CancellationToken ct = default);
editNote(id: string, attachmentId: number, text: string): Promise<boolean>;

Parameters

id : guid

Id of the Event to edit the note of.

attachmentId : int

Id of the attachment to edit. This has to be a note attachment or this function will fail.

text : string

The note’s updated text. This will replace all previously set text.

Result : bool

True if successful.

Errors

Data.NotFound ≥wg 0.4.9

The requested data was not found or the caller does not have the required permission to access it. For additional information, see Data.NotFound.

Data.Forbidden ≥wg 0.4.9

The caller does not have the required permissions to access the data. For additional information, see Data.Forbidden.

Event.EditNote.NoAttachmentLicense ≥wg 0.4.9

The product is not licensed for attachment handling.

Event.EditNote.EventIsCompleted ≥wg 0.4.9

Events that are already completed cannot have their attachments modified.

Event.EditNote.StationHasNoControl ≥wg 0.4.9

Attachments can only be modified if the station is allowed to modify the event.

Event.EditNote.NotAccepted ≥wg 0.4.9

Attachments can only be modified if the event was accepted or this prerequisite is disabled in the settings.

Remarks

This method requires API write access.