API Releases & Changelog

Information on new IoT Accelerator API releases and related documentation.
Changelog will be available at every new release. 

Current API release

The current release of IoT Accelerator is 23.1

API CHANGELOG IN 23.1

  • New API released in Early Availability (EA)
  • New API released in Early Availability (EA)
  • New API released in Early Availability (EA)
  • New API released in Early Availability (EA)
  • New API released in Early Availability (EA)
  • New method added: GET/aggregated-traffic-usages/top-usage-subscriptions

 

API CHANGELOG AFTER 22B1

  • "state-details" endpoint removed from API

API CHANGELOG IN 22B1

  • MSISDN field added to subscriptions information
  • eUICC type added to eUICC information
  • support consumer euicc agreements
  • support CONSUMER-type locales
  • New API released in Limited Availability
  • New API released in General Availability
  • "POST /actions/prepare-consumer-esim-profile": operation added
  • "GET /euiccs/{id}": additional states added in the response
  • "GET /euiccs/{id}/extended": additional states added in the response
  • "POST /euiccs/{id}/set-fallback-attribute": errorMessage added in the response
  • "GET /subscriptions/{imsi}": additional states added in the response
  • "GET /subscriptions/{imsi}/extended" : additional states added in the response, profileStatus removed from response
  • POST /euiccs/euiccOrder": new parameters added/removed to request model
  • GET /subscriptions/requests/{requestId}": new values added in the response
  • POST /subscriptions/requests/find": new value added in the response
  • API now released in GA (General Availability)
  • API has changed name from "Device usage reports" to "Subscription signalling usages"
  • API now released in GA (General Availability)
  • API has changed name from "Device signalling events" to "Subscription signalling events"
  • New API released in Limited Availability
  • New API released in General Availability
  • "lastSubscriptionChangeDateAt" added in IMSI attributes
  • "Attachments","activities","VIPincidentcount" added in "incidents" endpoint.
  • "Upload incident activity attachment" method added
  • "Download incident activity attachment" method added
  • New query parameter added: template_sp_id
  • New method added: Deactivate Subscription Package
 
  • API notation aligned to CamelCase as per IoT Accelerator API first directives.
    YAML file updated accordingly
 
  • API notation aligned to CamelCase as per IoT Accelerator API first directives.
    YAML file updated accordingly
 
  • API status moved from Limited Availability to General Availability
  • API notation aligned to CamelCase as per IoT Accelerator API first directives.
    YAML file updated accordingly
 
Title: Custom Field API
Changes:
  • API status moved from Limited Availability to General Availability
  • API notation aligned to CamelCase as per IoT Accelerator API first directives.
    YAML file updated accordingly

Title: eUICC Setup (CSP & Advanced Resellers only)
Change: New API now released in Early Availability.
  • New API released in Limited Availability.
 

Title: Enterprise Management API
Changes:

  • "pageNumber", introduced "default" attribute, set to 1
  • "sim_order_minimum" attribute is now optional 
  • Removed “id:asc” and “id:desc” from the sort parameter
  • Changed the default sort parameter from “id:asc” to “occurred_at:asc”
  • Limited the IMSI/MSISDN list to 15 in the request
  • Limited the IMSI/MSISDN list to 15 in the request
  • Maximum interval to query is now 8 days back in time
  • new POST endpoint '/enterprises/{enterprise_id}/subscription-packages'
  • new GET endpoint '/enterprises/{parent_enterprise_id}/offers'
  • new "offers"  and "enterprise_group_id" fields in EnterpriseDetail
  • new "offer_ids" field in EnterpriseCreate
  • new SubscriptionPackageBase,Offers,Offer,TpsPriceMap objects
Title: Custom Field API
Change:
  • New API now released in Early Availability.

Title: Subscription management API
Change:

  • new parameter "preferredDeliveryDate" has been added to the response of "GET/subscriptions/pendingOrders".
    Swagger page updated accordingly.
  • Region Query and Region Change API operations now moved from Early Availability to General Availability.
  • New search parameter added (Custom Field) as Primary and Secondary Key.
    Note: API is still in Eraly Availability.
    YAML file updated accordingly.

Title: Device reconnect API
Change:

  • New API now released in General Availability

Title: Subscription change history API
Change:

  • New API now released in General Availability

Title: Subscription management API - additional functions
Change:

  • Region Query and Region Change API operations released in Early Availability.
  • Change subscription ARP (alternative roaming providers) API released in General Availability.
  • Query sims with identifier and Query sims with customer label released in General Availability.

Title: Subscription Management API
Change:

  • updated with four new operations:
    POST/euiccs/euiccOrder
    POST/euiccs/stockOrder
    POST/euiccs/profileOrder
    POST/euiccs/multiProfileOrder

Title: Search Subscription Details API
Change:

  • New API now released in Early Availability

Title: Ticketing service API for incident management
Change:

  • New API published in general availability - CSP only

Title: Device reconnect API
Change:

  • New API published in limited availability

Title: Subscription change history API
Change:

  • New API published in limited availability

Title: Subscription management API - additional functions
Change:

  • New API published in limited availability.
    NOTE: This API includes the methods reported in previous "Change subscription state/owner/package" API.

Title: Device Localization API
Change:

  • updated with two new operations:
    POST /euiccs/{id}/set-fallback-attribute
    POST /euiccs/{id}/migrate
 

Title:  Signalling Events API
Change:

  • New API published in limited availability

Title: Device Usage Reports API
Change: 

  • New API published in limited availability

Title: Enterprise Management API
Change: 

  • New API published in General Availability

Title: Shared Bundle API
Change: 

  • API now published in General Availability

Title: Device Localization API
Change:  

  • updated with two new operations:
    POST /euiccs/{id}/set-fallback-attribute
    POST /euiccs/{id}/migrate