Subscribe or Unsubscribe to Change Indicators

This operation subscribes to or unsubscribes from active change markers and sets or updates the retention period and cadence of new or existing subscriptions. If you do not specify a retention period and cadence, their default values are applied to the subscription. The response returns all active subscriptions.

Example requests

The following example request payloads demonstrate the most common use cases.

First use case

This example request creates or updates a subscription and sets the cadence and retention period:

[
  {
    "id": "1",
    "retention": "15d",
    "cadence": "1h"
  }
]

Second use case

This example request creates or updates a subscription and sets the cadence and retention period to default values:

  {
    "id": "1"
  },
  {
    "id": "2"
  }
]

Third use case

This example request creates or updates a subscription and sets the cadence and retention period, and includes all of the unchangeable, read-only values in the request payload:

  {
    "markerTypeId": 13,
    "product": "forecasting",
    "category": "labor-forecast",
    "subCategory": "labor-forecast",
    "markerName": "forecasting_labor-forecast_labor-forecast",
    "objectType": "emp",
    "active": "true",
    "resourceUrl": "/v1/timekeeping/timecard_metrics/multi_read",
    "retention": "30d",
    "cadence": "15m"
  }
]