Function: event.AddNote

Adds a note attachment to an Event. Only works for accepted Events.

Syntax

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

Parameters

id : guid

Id of the Event to add the note to.

text : string

The note’s text.

Result : int

Id of the newly added note attachment. This Id is only valid in the context of the Event the attachment was created for.

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.AddNote.SettingsPreventAdding ≥wg 0.4.9

Adding attachments is disabled in the settings.

Event.AddNote.NoAttachmentLicense ≥wg 0.4.9

The product is not licensed for attachment handling.

Event.AddNote.EventIsCompleted ≥wg 0.4.9

Attachments cannot be added to events that are already completed.

Event.AddNote.StationHasNoControl ≥wg 0.4.9

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

Event.AddNote.NotAccepted ≥wg 0.4.9

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

Remarks

This method requires API write access.