Kourier Integrator Online Help

REST Subscription Detail

Purpose

Use this page to view the information used to create the subscription as well as statistical information pertaining to the processing of the subscription.

Available Toolbar Commands

Click the Delete icon in the toolbar to delete the current REST subscription. You will be prompted with a "Are you sure you want to delete?" dialog. Clicking Yes will permanently delete the REST subscription and then return to the REST Subscriptions page. Click Cancel to return to the existing export without deleting.

Click the Help balloon to open the help for this page.

Field Descriptions - Subscription Information

Field Name

Description - Usage - Notes

Subscription ID

The unique identifier for this specific subscription.

Resource

The resource associated with the subscription. The resource ID includes the version and the resource name.

Resource File

The U2 file associated with the resource when the subscription was created.

Submit URL

The URL that was used to create the subscription. The URL must include all required fields for the export that implements the resource. Additionally, the following standard query parameters can be specified:

  • Fields
  • Output As
  • Per Page

Callback URL

The receiver’s Call Back URL.

Callback Auth

The receiver’s Call Back BASIC authentication string, if specified.

Description

Descriptive text that the API consumer can associate with this subscription.

Status

Indicates the status of the subscription.

Status Desc

Displays a system generated text string/message related to the Status field.

Subscriber

The gateway user associated with this subscription.

Events

The events for this subscription. These will always be UPDATE and DELETE.

Field Descriptions - Statistical Information

Field Name

Description - Usage - Notes

Created

The date and time when the subscription was created.

Runs

The number of times the subscription has been processed.

Records Seen

The total number of net change records processed for this subscription.

Checksum Filtered

The number of net change records that passed the selection criteria and were skipped because of matching checksums.

Update Records Sent

The number of net change records that were serialized into the UPDATES payload.

Update Payloads Sent

The number of UPDATE payloads created.

Hard Deletes Sent

The number of “hard delete” net change records that were serialized into the DELETES payload. A hard delete is a record that has been physically removed from the database.

Soft Deletes Sent

The number of “soft delete” net change records that were serialized into the DELETES payload. A soft delete is a record that exists within the database but does not pass the selection criteria in the export.

Last Run

Last date and time that the subscription was processed.

Update Payloads Sent

The number of UPDATE payloads created.

Delete Payloads Sent

The number of DELETE payloads created.

Total Runtime

Total elapsed processing time (in milliseconds) used to process the subscription.

Related Topics: 

HOW TO - Implementing the SUBSCRIBE Method in a Resource

HOW TO – Create a Subscription for a RESOURCE using Postman