Versions Compared

Old Version 5

changes.mady.by.user Tijmen Daatselaar

Saved on

compared with

New Version Current

changes.mady.by.user Tijmen Daatselaar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
iconfalse
titleWhat is it for?

AQ_DeleteInstance is used for removing instances from the profile

What does it do?

This delete instance service will remove instances from the profile depending on the parameters. The service can be used to delete the active instance of a certain type, or to delete all instances from a relation attribute.

UI Text Box
type
Info

The service honors the stop-on-errors flag set by previous service in the flow.

The type-scope parameter may be used to indicate if all instances in the profile matching the type should be processed (Global mode), or only the active instance of the specified type (Active mode). When the global mode is used as type-scope, the exact-type parameter may be used to specify if only instances that exactly match the type (default) should be deleted, or if also derived instances should be processed.

In case there are no instances available and the type-scope is Active, the service will return an error Unknown instance, or no active instance. In case the type-scope is Global no warning or error will be shown.

A condition expression may optionally be provided to restrict the number of instances that are deleted to only those instances for which the condition evaluates to true.

Parameters

type

NameDescriptionTypeRequired
attribute-path

The name of the relation from which all instances should be deleted. Dotted notation is permitted in the path.

UI Text Box
type
Info

When a relation is used that does not contain any instances, the service call does not have any effect (except a few log statements).

String

No1

type

The type of the entity of which the instance(s) should be removed

UI Text Box
Info

When the type parameter is used, but no active instance is found for the specified type, the service raises an exception.

String

No1

conditionA condition expression that will evaluate to either true of false. This condition, when specified, will be evaluated for each instance, and only instances for which the condition evaluates to true will be deleted.StringNotype-scope

Can be be Active or Global. Active will clear only the active instance of the specified type. Default is Active.

Info
UI Text Box
typenote

The type-scope parameter is only relevant when the type parameter is specified.

ActiveNoexact-type

Boolean parameter that may be used to indicate if only instances that exactly match the specified type should be cleared, or when the value is false derived types are also processed.

note
UI Text Box
type
Info

The exact-type parameter is only relevant when the type-scope is set to global.

BooleanNo

1 Exactly one of the parameters attribute-path and type must be defined. When both or none of the parameters defined, the service raises an exception.