Function: event.RemoveInput

Removes an input value for an Event. This removes the specified value from the context or the whole context if no value is specified.

Syntax

{
	"method": "event.RemoveInput",
	"params": {
		"id": "...",
		"context": "...",
		"value": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<void> RemoveInput( AdvGuid id, AdvString context, std::optional<AdvString> value = std::nullopt );
public Task RemoveInputAsync(Guid id, string context, string? value = null, CancellationToken ct = default);
removeInput(id: string, context: string, value?: string | undefined): Promise<>;

Parameters

id : guid

Id of the Event to remove the input for.

context : string

Context for the input value.

value : string optional

Input value.

Result : void

Errors

Data.Forbidden

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

Data.NotFound

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

Precondition.Failed

Specific required conditions were not satisfied before processing. Details can be found in the error message. For additional information, see Precondition.Failed.

Remarks

This method requires API write access.

Preconditions

  • Visibility (only unarchived Events)
  • The Event must not be completed.
  • event.modify right

Visibility

  • An unarchived Event isn’t visible to the caller if it is assigned to a different Station and the Event’s NotifiedStations property doesn’t contain the caller’s Station. The right “See events of other stations” circumvents this check.
  • An Event isn’t visible to the caller if it belongs to a foreign Segment.
  • An Event isn’t visible to the caller if the Event view rights don’t permit it.
  • An Event isn’t visible to the caller if the Event’s Datapoint view rights don’t permit it.
  • An Event isn’t visible to the caller if the Event’s Location view rights don’t permit it.