Skip navigation
IoT Accelerator Developer Portal
Home Learn API Documentation IoT Accelerator REST API
In this section

IoT Accelerator REST API

This section describes the REST APIs exposed by the IoT Accelerator. For each group of APIs, there is a description of the main resources and then a link to the swagger page to test them.

Please note that for testing the APIs you will need to have an active IoT Accelerator account and its associated credentials. Google Chrome is the suggested browser to access the swagger pages.

IMPORTANT:

As there are slight differences in how the initial authorization of API is performed in the system for the different groups of APIs listed here, please have a look at the quick start guide to get all the details and understand the differences.

API Groups

User administration  |  Consumer connectivity  |  Subscription management  |  Subscription management - additional functions | Device localization |  Subscription signalling events | Subscription signalling usages | Shared bundle | Enterprise management | EUICC Setup (CSP & Advanced Resellers only) | Device reconnect | Subscription change history | Search subscription details | Ticketing service for incident management | SMS-Messaging | Enterprise provisioning for Marketplace Hub API (CSP Only) | Custom fields | Subscription location | Devices: Inventory and detailed view | Business Analytics Report | Resource Inventory | Incident Management | SIM Specification API (CSP only) | Organization Signaling Aggregations | Business Automation 

 

 

User administration

This group of APIs offers an interface to manage users identity.
User Administration API is based on the Representational State Transfer (REST) interface.

This API requires X-access-token authentication using the POST/login as token release method. Please check the description in the API quick start guide.

Want to test the API?

Try out the API Swagger to explore and test APIs directly from your browser using your IoT Accelerator account credentials.

Services Operations

Operational Insights
Login    
  POST /login Sign in and authenticate the user.
  POST /login-form Sign in and authenticate the user.
  POST /token-reissue Returns a new token
Users    
 

POST /list-assignable-roles

Returns the list of roles a user has in the specified organizations. Retrieve a list of roles that the authenticated user can assign to a suer that has the specified organization list.

 
  GET /users

Returns the list of users and their details that are visisble to the current authenticated user.
  POST /users

Creates a new user. Initiates the creation of a new user.
 

DELETE /users/{id}

Initiates the deletion of a user. The string {id} must be replaced with an actual user ID in the endpoint URL.
 

GET /users/{id}

Returns the details of a user. The string {id} must be replaced with an actual user ID in the endpoint URL.
  PUT /users/{id}

Updates a User. Initiates changes to a user. Users can be updated through this endpoint. The string {id} must be replaced with an actual user ID in the endpoint URL.
  GET/users/{id}/accessible-organizations

Returns the organizations a user has access to. The string {id} must be replaced with an actual user ID in the endpoint URL.
  PUT /users/{id}/password

Sets the password of a user. The string {id} must be replaced with an actual user ID in the endpoint URL.

 

Consumer connectivity

This API provides an interface to consumer connectivity management functionality.
Consumer Connectivity API is based on the Representational State Transfer (REST) interface.

This API requires X-access-token authentication using the POST/login as token release method. Please check the description in the API quick start guide.

NOTE:  This API may not be available out of the box. Please get in touch with your Service Provider to verify if the functionality is available, and if your account could be enabled to use it.

Want to test the API?

Try out the API Swagger to explore and test APIs directly from your browser using your IoT Accelerator account and credentials.

Services Operations

Operational Insights
Data Balances    
  GET /data-balances/{company-id}/{subscription-id-type}/{subscription-id} Returns data balance of a subscription.
Login    
  POST /login Sign in and authenticate the user.
  POST /login-form Sign in and authenticate the user.
  POST /token-reissue Returns a new token
Products    
  GET /products/{company-id} Returns a list of products of a company.
  GET /products/{company-id}/{product-id} Returns a product of a company.
  GET /products/{company-id}/properties/values

Returns valid product property values of a company.
  POST /products

Creates a new product for a company.
  PUT /products

Updates a product of a company.
Purchases  

 
  GET /purchases/{company-id}/{subscription-id-type}/{subscription-id}/{purchase-id}

Returns a purchase of a subscription.
  PUT /purchases/{company-id}/{subscription-id-type}/{subscription-id}/refund

Refunds a purchase of a subscription.
  DELETE /purchases/buckets/{company-id}/{subscription-id-type}/{subscription-id}/{purchase-id}

Deletes a bucket of a subscription by purchase ID.
  POST /purchases/{company-id}/{subscription-id-type}/{subscription-id}/free

Purchases a product as a free product.
  GET /purchases/{company-id}/{subscription-id-type}/{subscription-id}

Returns a list of purchases of a subscription.
  POST /purchases/{company-id}/{subscription-id-type}/{subscription-id}

Purchases a product.
Recurring purchases  

 
  GET /recurring-purchases/{company-id}/{subscription-id-type}/{subscription-id}

Returns a list of active recurring purchases of a subscription.
  DELETE /recurring-purchases/{company-id}/{subscription-id-type}/{subscription-id}/{purchase-id}

Cancels a recurring purchase of a subscription. Existing data bucket will not be deleted.
  PUT /recurring-purchases/{company-id}/{subscription-id-type}/{subscription-id}/pause

Pauses or resumes a recurring purchase of a subscription.
  PUT /recurring-purchases/{company-id}/{subscription-id-type}/{subscription-id}/free

Sets free recurring purchases for a subscription.
Subscriptions  

 
  PUT /subscriptions/reset

Resets a subscription.
  GET /subscriptions/{subscription-id-type}/{subscription-id}

Returns a subscription.

 

Subscription management

This API offers a web application interface to perform operations related to the inventory and management of subscriptions.
Subscription Management API is based on the Representational State Transfer (REST) interface.

This API requires X-access-token authentication using the POST/login as token release method. Please check the description in the API quick start guide.

Want to test the API?

Try out the API Swagger to explore and test APIs directly from your browser using your IoT Accelerator account and credentials.

Services Operations

Operational Insights
Login    
  POST /login Sign in and authenticate the user.
  POST /login-form Sign in and authenticate the user.
  POST /token-reissue Returns a new token
SubscriptionOrder    
  POST /subscriptions/orders/{orderId}:approve Approve an order pending for approval.
  DELETE /subscriptions/orders/{orderId} Reject an order pending for approval.
  POST /subscriptions/stockOrders Order SIM Stock
  POST /euiccs/euiccOrder

Order eUICC
  POST /euiccs/stockOrder

Order eUICC Stock
  POST /euiccs/profileOrder

Order Subscription Profile Stock
  POST /euiccs/multiProfileOrder

Perform a multi-profile eUICC Order
  GET /subscriptions/pendingOrders Get pending order approvals.
  POST /subscriptions/order Order SIM cards
  GET /subscriptions/stockOrders/metadata Get metadata for SIM Stock Order.
  GET /subscriptions/order/metadata Get metadata for SIM Order.
SubscriptionInventory    
  GET /subscriptions/details/{key}/{value} Get subscription details by secondary key.
This APi will be deprecated March 10th 2023.
Use this REST API instead.
  POST /subscriptions/disabledApns Disable one or more APNs for one or more subscriptions.
  POST /subscriptions/details Get subscription details by primary key.
This APi will be deprecated March 10th 2023.
Use this REST API instead.
  GET /subscriptions/{id}/history Query history of a subscription.
  GET /subscriptions/requests/{requestId} Get details for a single subscription request.
  POST /subscriptions/{imsi}:reassignMsisdn Reassign MSISDN into a new subscription identified by IMSI.
  POST /subscriptions/requests/find Find Subscription Request IDs based on Search Criteria
  POST /subscriptions/{id}:assignImei Update assigned-imei of a subscription.
  GET /subscriptions/returnedMsisdns Query Returned Msisdns within specific time period
  POST /subscriptions/{subscription_id}:suspendSubscription Suspend Subscription.
  POST /subscriptions/{subscription_id}:changeMsisdn Activate Subscription.

 

Subscription management - additional functions

This API provides additional subscription management functions, such as: change subscription owner, change subscription package, change subscription state, change subscription region, query subscription available regions, query sim resource, change alternative roaming profile, cancel SIM order types for: SIM stock order, SIM order, Euicc stock order, Euicc order,  subscription profile stock order.

NOTE: This API descritption replaces and includes the "Change subscription state/owner/package" API methods.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file. 

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
SubscriptionManagementAPI    
  POST /requests/owner-changes

Create an owner change request.
  POST ​/requests​/package-changes Create a package change request.
  POST /requests/state-changes Create a state change request.
  POST /requests/region-changes Create a region change request.
  POST /requests/arp-changes Change subscription ARP (alternative roaming providers) requests.
  POST /state-details Query state details
  GET /regions Query available regions request.
  GET /sims/{id} Query sims with identifier.
  GET /sims Query sims with customer label.
  DELETE /sim-orders/{request-id} Cancel sim order with provided id.

 

Device localization

This API that provides users with a web application interface, mainly to localize embedded Universal Integrated Circuit Cards (eUICCs) and query subscription data over HTTPS.
Device Localization API is based on the Representational State Transfer (REST) interface.

This API requires X-access-token authentication using the POST/login as token release method. Please check the description in the API quick start guide.

Want to test the API?

Try out the API Swagger to explore and test APIs directly from your browser using your IoT Accelerator account and credentials.

Services Operations

Operational Insights
Login    
  POST /login  
  POST /login-form  
  POST /token-reissue  
Monitoring    
  GET /monitor/echo/{message} Echo message back to caller.
Localization    
  POST /actions/allocate-profiles Initiate allocation of a subscription profile
  POST /actions/prepare-consumer-esim-profile Prepare Consumer e-sim profile
  GET /euiccs/{id} Get details for a single eUICC.
  GET /serviceRequests/{id} Get details for a single service request.
  PUT /euiccs/label Initiate the update for labels of one or more eUICCs
  POST /euiccs/{id}/localization Initiate localization of an eUICC.
  POST /euiccs/{id}/delocalize Initiate delocalization of an eUICC.
  POST /euiccs/{id}/disable Initiate the disabling of the active subscription profile of an eUICC.
  POST /euiccs/{id}/download Initiate the download of a subscription profile to an eUICC.
  POST /euiccs/{id}/delete Initiate the deletion of a subscription profile from an eUICC.
  GET /euiccAgreements Get list of eUICC agreements.
  GET /subscriptions/{imsi} Get details for a single subscription.
  GET /subscriptions/{imsi}/extended Get extended details for a single subscription.
  GET /allowedCompanies Get list of companies the user is allowed to perform operations on.
  GET /euiccs/{id}/extended Get extended details for a single eUICC.
  GET /locales Get locales available in a localization table.
  POST /euiccs/{id}/set-fallback-attribute Initiate the setting of fallback attribute on an eUICC.
  POST /euiccs/{id}/migrate Initiate the migration of an eUICC.

 

Subscription signalling events

 

This low level API provides resources for getting signalling events for subscriptions.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file. 

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

IMPORTANT! This API replaces the previous ! "Device signalling events" API which was in Early Availability state.

Services Operations

Operational Insights
Events    
  GET /events

List subscription events
  GET /events/{event_id} Get subscription event details

 

Subscription signalling usages

This API provides resources for getting aggregated usage reports for subscriptions.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file.

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

IMPORTANT! This API replaces the previous! "Device usage reports" API which was in Early Availability state.

Services Operations

Operational Insights
Reports    
  GET ​/data-usage

Aggregated reports of data usage.
  GET ​/sms-usage Aggregated reports of SMS usage.

 

Shared bundle

The Shared Bundle API provides resources to retrieve information about an organization usage and limits of shared bundles. The Shared Bundle API is based on the Representational State Transfer (REST) interface.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file. 

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Shared bundle    
  GET ​/shared-bundles

List shared bundles.
  GET ​/shared-bundles/{id} Shared bundles details.

Enterprise provisioning for Marketplace Hub API (CSP Only)

This API is used to perform all the provisioning activities in IoT Accelerator for Marketplace HUB use case.

Marketplace hub is an additional service upon request, so it is not active by default. Please get in touch with your Ericsson support team for further details.

This API requires Bearer authentication using the POST/auth/login as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file.

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Auth    
  POST /auth/login Authenticates user using external OIDC authentication provider
  GET /auth/logout Logout user using external OIDC authentication provider
  GET /auth/refresh Refreshes bearer token
  GET /auth/userinfo Returns user info object
Dimension    
  GET /dimensions Returns all dimensions of provider
  GET /listings/dimensions/{id} Fetch single dimension
  GET /listings/{id}/dimensions Fetch all dimensions for a listing
Listing    
  GET /listings Returns listings filtered by name and paginated
  GET /listings/{id} Returns the matching listing
  GET /listings/{id}/channels Returns channel data for listing
Subscription    
  GET /subscriptions Returns list of subscriptions
  POST /subscriptions Creates new subscription through REST API channel
  GET /subscriptions/counts Returns counts for subscriptions in various states
  GET ​/subscriptions​/counts​/action-required Returns counts for subscriptions with required action
  GET ​/subscriptions/events/{id} Retrieves a detailed description of an event
  GET ​/subscriptions/{id} Returns detailed subscription
  GET ​/subscriptions/{id}/events Returns events of subscription
Version    
  GET ​/version Retrieves build information

Enterprise management

This API provides a resource to retrieve information about enterprises and to manage them.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file. 

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Enterprise    
  GET /enterprises List enterprises
  POST /enterprises Create a new enterprise
  GET /enterprises/{enterprise_id} Get details of an enterprise
  PUT /enterprises/{enterprise_id} Update an existing enterprise
  POST /enterprises/{enterprise_id}/statuses Change the status of the enterprise
  GET /enterprises/{enterprise_id}/subscription-packages /enterprises/{enterprise_id}/subscription-packages
  POST
​/enterprises​/{enterprise_id}​/subscription-packages		 Create subscription packages for my enterprise
  GET /enterprises/{parent_enterprise_id}/offers List the offers belonging to the certain parent enterprise
  POST ​/enterprises​/subscription-packages/{subscription_package_id}/deactivate Deactivate the subscription package
Network Group    
  GET /enterprises/network-groups List network groups
SIM Specification    
  GET /enterprises/sim-specifications List SIM specifications

 

eUICC Setup (CSP & Advanced Resellers only)

This API provides CSPs and Advanced Resellers a number of self-service operations to allow eUICC profiles provisioning and configurations.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?
Download the YAML file. 

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

IMPORTANT! This API is still in Limited availability! If you are an Advanced Reseller interested in testing and providing feedback, please request access to your Connectivity Service Provider. If you are a Connectivity Service Provider, please request access to your Ericsson Customer Support representatives.

Services Operations

Operational Insights
EuiccAgreement    
  POST /euicc-agreements Store eUICC Agreement
  GET /euicc-agreements List eUICC Agreements
  PUT /euicc-agreements/{euiccAgreementId} Update eUICC Agreement
  DELETE /euicc-agreements/{euiccAgreementId} Delete eUICC Agreement
  GET /euicc-agreements/{euiccAgreementId} Get eUICC Agreement
LocalizationTable    
  POST/localization-tables Store localization table
  GET /localization-tables List localization table
  DELETE /localization-tables/{localizationTableId} Delete localization table
  GET /localization-tables/{localizationTableId} Get localization table
  PUT /localization-tables/{localizationTableId} Update localization table parameters
Locale    
  GET /localization-tables/{localizationTableId}/locales/{localeId} Get locale
  DELETE /localization-tables/{localizationTableId}/locales/{localeId} Delete single localization table item
  PUT /localization-tables/{localizationTableId}/locales/{localeId} Update locale
  POST /localization-tables/{localizationTableId}/locales Add localization table items into localization table
  GET /localization-tables/{localizationTableId}/locales List locales for a localization table

 

Ticketing service for incident management

This API provides a resource for getting information about incidents and manage them.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file.

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Incidents    
  POST /incidents/search

Search for incidents.
  GET ​/incidents List incidents.
  POST /incidents Create incident.
  GET /incidents/{incident_id} Incident with activities.
  GET /incidents/{incident_id}/status Incident status.
  PUT ​/incidents​/{incident_id}​/status Update incident status.
  GET /incidents/getVIPIncidentCount/{organization_id} Get VIP Incident for Premium Operator.
Attachments    
  GET /incidents/{incident_id}/attachments

Incident attachments.
  POST /incidents/{incident_id}/attachments

Upload incident attachment.
  GET /incidents/{incident_id}/attachments/{attachment_id}

Download incident attachment.
  POST /incidents/{incident_id}/activities/{activity_id}/attachments

Upload incident activity attachment.
  GET /incidents/{incident_id}/activities/{activity_id}/attachments/{attachment_id}

Download incident activity attachment.
Activities    
  POST /incidents/{incident_id}/activities

Create new activity.
  GET /incidents/{incident_id}/activities/{activity_id}/status

Get activity status.
  PUT /incidents/{incident_id}/activities/{activity_id}/status

Get activity status.

 

Device reconnect

This API request creates a subscription device reconnect request. The change can be requested for one subscription.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file. 

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Default    
  POST /device-reconnect

Create a device reconnect request.

 

Subscription change history

Create a request to get subscription change history for a batch of subscriptions.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file. 

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Default    
  POST /requests

Request subscription change history.
  GET /requests/{request-id} Get results for subscription change history request.

 

Search Subscription Details

This API allow to perform a search in the subscription inventory and obtain subscription information.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file.

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Search Subscription Details    
  POST​/details​

Subscriptions search with identifier.
  GET​/details​

Search with company id, label or custom fields.

 

SMS messaging

The SMS Messaging API allows a web application to send and receive SMS messages over HTTPS and simplifies the communication between the enterprise and the IoT Accelerator SMSC. The service supports the sending and receiving of both binary and text SMS messages.

Note: This API is not active by default. Please get in touch with your Service Provider and ask for activation.

This API requires Basic authentication. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file. 

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
sendSMS    
  POST /outbound/{senderAddress}/requests 

Sends an SMS message to one or more devices.
querySMS    
  GET /outbound/{senderAddress}/requests/{requestId}/deliveryInfos

Queries the delivery status of an SMS.
retrieveSMS    
  GET /inbound/registrations/{registrationID}/messages

Retrieves an SMS sent to a web application.

 

Custom fields

Custom fields are user-defined key-value pairs. They can be used for advanced filtering capabilities on single subscriptions as well as batch jobs. Custom fields can be created, modified and attached to subscriptions using this api.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file.

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Subscription Custom Fields    
  POST /custom-fields

Create a custom field
  GET /custom-fields

Get custom fields
  PUT ​/custom-fields​/{id}

Update custom field
  DELETE ​/custom-fields​/{id}

Delete a custom field
  POST ​/custom-fields/requests

Create a subscription custom field update request.

 

Subscription location

This API provides Cell Global Identity (CGI) of a subscription.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

IMPORTANT! This API is still in Limited availability! If you are interested in testing and providing feedback, please request access to your Connectivity Service Provider, which will provide you more information on when the API could be available for you to try. If you are a Connectivity Service Provider, please get in touch with Ericsson Customer Support representatives. 

Want to test the API?

Download the YAML file.

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Device    
  GET /cell-global-identities
Get cell global identity information of a subscription.

 

Device API: SIM & eUICC inventory

This API provides standard SIM and eUICC inventory and information about embedded subscriptions.

IMPORTANT! This API is still in Early Availability (EA). If you are interested in testing and providing feedback, please request access to your Connectivity Service Provider, which will provide you more information on when the API could be available for you to try. If you are a Connectivity Service Provider, please get in touch with Ericsson Customer Support representatives.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file.

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Device    
  GET /devices

List Devices
  GET /devices/{idType}/{value}

Get Device Details

Business Analytics Report

This API API provides methods to retrieve an organization's report and invoice information.

This API is a replacement and modernization of the ReportDownload and UsageDataDownload SOAP API groups which are going to be deprecated.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?
Download the YAML file.

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

IMPORTANT! This API is released in General Availability.

Services Operations

Operational Insights
Reports    
  GET /reports

Query report data files
  GET /reports/{id}

Download a report data file
Invoices    
  GET /invoices

Query invoice data files
  DELETE /invoices

Delete an invoice data file
  GET /invoices/{id}

Download an invoice data file
Usages    
  GET /usages

Query usage data files
  GET /usages/{id}

Download a usage data file
Aggregated traffics
  GET /aggregated-traffic-usages/top-usage-subscriptions

Query the top subscriptions with most traffic usage.

 

Resource Inventory

Inventory APIs will allow both operators and Advanced Resellers to list Roaming Profile and APN related network resources and get details of each specific resource.

IMPORTANT! This API is still in Limited availability! If you are interested in testing and providing feedback, please request access to your Connectivity Service Provider, which will provide you more information on when the API could be available for you to try. If you are a Connectivity Service Provider, please get in touch with Ericsson Customer Support representatives.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file.

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Resource Inventory    
  GET /esm-profiles

Get ESM profiles list
  GET /esm-profiles/{id}

Get details of an ESM profile
  GET /esm-contexts

Get ESM contexts list
  GET /esm-contexts/{id}

Get details of an ESM context
  GET /pdp-context-profiles

Get PDP context profiles list
  GET /pdp-context-profiles/{id}

Get details of a PDP context profile
  GET /esm-context-qos

Get ESM context QoSs list
  GET /esm-context-qos/{id}

Get details of an ESM context QoS
  GET /esm-profile-qos

Get ESM profile QoSs list
  GET /esm-profile-qos/{id}

Get details of an ESM profile QoS
  GET /pdp-context-qos

Get PDP context QoSs list
  GET /pdp-context-qos/{id}

Get details of a PDP context QoS
  GET /apns

Get APNs list
  GET /apns/{id}

Get details of an APN
  GET /roaming-profiles-2g3g

Get 2G3G roaming profile inventory list
  GET
/roaming-profiles-2g3g/{id}


Get details of a 2G3G roaming profile
  GET /roaming-profiles-4g

Get 4G roaming profile inventory list
  GET
/roaming-profiles-4g/{id}

Get details of a 4G roaming profile
Operator network nodes  
  GET /network-nodes

Get list of network nodes
Operator network  
  GET /operator-networks

Get operator networks

Incident Management API

The Incident Management API provides resources to create, view and manage incidents. This is a new IOTA Incident Management API which will replace the previous.

IMPORTANT! This API is still in Early Availability (EA). If you are interested in testing and providing feedback, please request access to your Connectivity Service Provider, which will provide you more information on when the API could be available for you to try. If you are a Connectivity Service Provider, please get in touch with Ericsson Customer Support representatives.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file.

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Category    
  GET /categories

Browse categories
  GET /categories/{categoryId}

Get categories details for a given category Id
  GET /categories/groups

Fetch the category groups available
  GET /categories/groups/{categoryGroupId}

Get categories details for a given category group Id
Review    
  POST /reviews Create Review for any form
  GET /reviews

Fetch Review for a for a form
  GET /reviews/{reviewId}

Get review details based on a given review Id
  PUT /reviews/{reviewId}

Update review details for a specific review Id
  DELETE /reviews/{reviewId}

Remove review based on its given review Id
Service    
  GET /services

Search form based on service/title
  POST /services

Search for a form by any of its known details
  GET /services/{serviceId}

Fetch form details based on form (service) Id
  GET /services/{serviceId}/myrequests

Get all tickets for current user, for a specific form by a given service Id
  GET /services/requests

Fetch all the tickets for current user
  POST /services/{serviceId}/requests/{requestId}/submissions

Submit a ticket that was previously initiated
  GET /services/requests/{requestId}

Search a ticket based on ticket Id
  POST /services/{requestId}/questionnaire/answers

Submit answer to a question on an initiated ticketId.
  GET /services/requests/{requestId}/answers

Fetch all the submitted answers for an already created ticket Id
  GET /services/requests/{requestId}/activities

Get activity details for a specific ticket Id
  POST /services/requests/{requestId}/activities

Post new ticket activity for a specific request Id
Requests    
  POST /requests

Initiating a new ticket
  GET /requests/{requestId}/questionnaire

Fetch ticket questionnaire details
Content    
  POST /contents

Prepare attachment content - that will be further used as answer into the attachment question
Access Token    
  POST /access-tokens

Fetch access tokens which would be used for authorizing purpose
Orders    
  POST /orders

Submit multiple tickets that were previously initiated after responding to all the mandatory questions

SIM Specification API (CSP only)

This API will allow operators to list all the SIM specifications and get details of each specific SIM specification, also list all the File share resources and get details of specific File share info for creating or modifying a SIM specification.

IMPORTANT! This API is still in Early Availability (EA). If you are interested in testing and providing feedback, please request access to your Connectivity Service Provider, which will provide you more information on when the API could be available for you to try. If you are a Connectivity Service Provider, please get in touch with Ericsson Customer Support representatives.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file.

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Specifications    
  GET /specifications

List all specifications
  GET /specifications/{id}

Get specific specification
File Shares    
  GET /file-shares

List all file share resources
  GET /file-shares/{id}

Get a file share resources

Organization Signaling Aggregations

This API is used to retrieve aggregated traffic data on real time usage statistics of traffic analytics for Organizations

IMPORTANT! This API is still in Early Availability (EA). If you are interested in testing and providing feedback, please request access to your Connectivity Service Provider, which will provide you more information on when the API could be available for you to try. If you are a Connectivity Service Provider, please get in touch with Ericsson Customer Support representatives.

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file.

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Organization Signaling Reports
  GET /signaling-aggregations/traffic-usages/{dimension}

Get organization traffic data statistics aggregated on dimension

Business Automation

This API provides operations for Triggered Actions and Ruleset Management.
The Business Automation API is based on the Representational State Transfer (REST) interface

This API requires Bearer authentication using the POST/token as token release method. Please check the description in the API quick start guide.

Want to test the API?

Download the YAML file.

Want to visualize the API in Swagger format?

Click here, a new tab will open. Please note that this is just for visualization, you cannot test the API in the Swagger page as CORS security protection will apply.

Services Operations

Operational Insights
Actions
  GET /triggered-actions

List Triggered Actions
  GET /triggered-actions/{id}

Get Triggered Action Detail
  GET /triggered-actions/summary

Get Triggered Actions Summary
Management
  POST /rulesets

Create a set of rules for a ruleset
  GET /rulesets

List rulesets
  GET /rulesets/{id}

Get Details of ruleset
  PUT /rulesets/{id}

Update Enabled ruleset
  DELETE /rulesets/{id}

Delete a ruleset
  POST /rulesets/draft

Save as Draft ruleset
  PUT /rulesets/{id}/change-status/{desiredStatus}

Update ruleset status