Subscriptions

patch

https://app.financekey.com/OData/Subscriptions({key})

Record the details of an arrangement to receive reports or data on a regular (defined) basis.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

name

string | null

A name for the subscription.

comment

string | null

Miscellaneous notes and information for the entry or record.

minimumRecordCount

int32

The minimum number of records that must be in the record set in order for the subscription to be triggered.

maximumRecordCount

int32

The maximum number of records in the record set. Above this number, and the subscription will not be fired.

pollingScheduleId

int32

The frequency at which the subscription is checked to see if the conditions are met.

notificationScheduleId

int32

The frequency at which notifications will be sent. Even if the polling schedule and condition are positive, a notification will only be sent if a notification is due.

embedResultSet

boolean

EmbedResultSet is a boolean field (data type 'bit') in the Subscription table that indicates whether the results of a particular query are embedded in the Subscription data itself. A value of '0' indicates that the query results are stored separately, and a value of '1' indicates that the query results are embedded in the Subscription data. This allows efficient storage of complex subscription result sets while also allowing efficient lookup of query results.

onceOnly

boolean

OnceOnly is a bit field in the Subscription table used to indicate whether a subscription has been processed before for a given user. This field is used to both prevent duplicate subscriptions and ensure that a user is only subscribed once. It will be set to 1 after a successful subscription.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!