OData Catalog Subscriptions Change: SubscriptionType Field Required

  • Date
    June 24, 2025
  • Type
    System updates
  • Satellite
    Copernicus Contributing Missions, Landsat, Sentinel-1, Sentinel-2, Sentinel-3, Sentinel-5P, Sentinel-6A

We would like to inform you about an upcoming change to our OData API interface within Catalog Subscriptions Service, effective 8 July 2025.

Starting from 8 July 2025, users will be obligated to define the "SubscriptionType" field in the request when creating a subscription. Depending on the type, the possible values will be:

  • push
  • pull

The value must be entered in the lowercase letters. The "SubscriptionType" field will also be displayed in the response.

Currently, the requests are defined as follows:

PULL Subscription request body example

{
 "StageOrder": true,
 "FilterParam": "Collection/Name eq 'SENTINEL-1' and Attributes/OData.CSC.StringAttribute/any(att:att/Name eq 'productType' and att/OData.CSC.StringAttribute/Value eq 'IW_SLC__1S')",
 "Priority": 1,
 "Status": "running",
 "SubscriptionEvent": [
 "created"
 ]
}

PUSH Subscription request body example

{
 "StageOrder": true,
 "FilterParam": "Collection/Name eq 'SENTINEL-2' and Attributes/OData.CSC.StringAttribute/any(att:att/Name eq 'productType' and att/OData.CSC.StringAttribute/Value eq 'S2MSI2A')",
 "Priority": 1,
 "NotificationEndpoint": "https://userservice/notification",
 "NotificationEpUsername": "serviceusername",
 "NotificationEpPassword": "********",
 "Status": "running",
 "SubscriptionEvent": [
 "created"
 ]
}

Upon the implementation of the change, requests must be defined in the following manner:

PULL Subscription request body example

{
 "StageOrder": true,
 "FilterParam": "Collection/Name eq 'SENTINEL-1' and Attributes/OData.CSC.StringAttribute/any(att:att/Name eq 'productType' and att/OData.CSC.StringAttribute/Value eq 'IW_SLC__1S')",
 "Priority": 1,
 "Status": "running",
 "SubscriptionEvent": [
 "created"
 ],
 "SubscriptionType": "pull"
}

PUSH Subscription request body example

{
 "StageOrder": true,
 "FilterParam": "Collection/Name eq 'SENTINEL-2' and Attributes/OData.CSC.StringAttribute/any(att:att/Name eq 'productType' and att/OData.CSC.StringAttribute/Value eq 'S2MSI2A')",
 "Priority": 1,
 "NotificationEndpoint": "https://userservice/notification",
 "NotificationEpUsername": "serviceusername",
 "NotificationEpPassword": "********",
 "Status": "running",
 "SubscriptionEvent": [
 "created"
 ],
 "SubscriptionType": "push"
}

We recommend reviewing the upcoming changes described above to avoid disruption to your current services.

OSZAR »