Skip to content

System Profiles⚓︎

Path⚓︎

/v1/system-profiles

A System Profile is used to apply a fixed set of parameters to one or more System(s) and/or Subscribers. It comprises one or more APN Profiles.

Multiple System Profiles can be created and made available for Subscribers of the same System. For example, establish tiered service levels by creating three System Profiles (bronze, silver, and gold) each with successively higher bandwidth levels.

 

Resource Attributes⚓︎

The attributes for the sub-profiles resource are detailed below:

Attribute Type Required? Description
name String YES The name of the system profile.
extensions Object NO A container for any additional custom parameters or metadata.

Example⚓︎

{
  "name": "ITprofile",
  "extensions": {}
}

 

Endpoints⚓︎

Request Examples⚓︎

Get a list of all system profiles::⚓︎

{baseUrl}/v1/system-profiles

Get a specific profile::⚓︎

{baseUrl}/v1/system-profiles/<profileID>

Get a list of all apn profiles associated with a system profile::⚓︎

{baseUrl}/v1/system-profiles/<profileID>/apnProfiles

Get the customer associated with a system profile::⚓︎

{baseUrl}/v1/system-profiles/<profileID>/customer

Get a list of all subscribers assigned a specific profile::⚓︎

{baseUrl}/v1/system-profiles/<profileID>/subscribers

Get a list of all systems using a system profile::⚓︎

{baseUrl}/v1/system-profiles/<profileID>/systems

The <profileID> is discovered by selecting or searching for a system profile.

Get search for a system profile. You can use findByDeepSearch to find specific system profile ID::⚓︎

{baseUrl}/v1/system-profiles/search/findByDeepSearch?searchString=<searchCriteria>