Notification: Add change subscription

Method

POST

Path

/qrs/notification?name={typename}&id={id}&filter={filter}&condition={condition}&changetype={changeType}&propertyName={propertyName}

Description

Add a change subscription that makes the Qlik Sense Repository Service (QRS) call the specified URL when an entity of {typename} type is changed.

To target a specific entity, use {id}.

To target several entities (for example, all apps where the app name starts with “sales”), use {filter}.

To add a condition for activating the change subscription (for example, add a subscription to an app, if published = true), use {condition}.

To define the types to subscribe to, use {changeType}.

To target a specific property or de-select a property in favor of all other properties, use {propertyName}.

Body

string

The string contains a URL.

Return value

GUID

Optional parameters

• {id}: To target a specific entity, use {id}.
• {filter}: To target several entities (for example, all apps where the app name starts with “sales”), use {filter}. The filtering is limited to properties of the entity type, single references, and any depth of single children.
• {condition}: To add a condition for activating the change subscription (for example, add a subscription to an app, if published = true), use {condition}.
Information noteThis functionality is under development and may change without prior notice.
• {changeType}: To define the types to subscribe to, use {changeType}.

For example, to subscribe to updates with a specific filter use:

public enum ChangeType
       {
              Undefined,
              Add,
              Update,
              Delete
       }

• {propertyName}: To target a specific property or de-select a property in favor of all other properties, use {propertyName}.

Examples:

Add a change subscription for apps with propertyName = "published" to call the URL whenever the published field is changed.

Add a change subscription for apps with propertyName = "!published" to call the URL whenever anything but the published flag (or the ModifiedDate field) is changed.

Information noteThe {propertyName} parameter supports base types, but not references or children.