Get a service policy.
Fetches a service policy. Connectivity subscriptions can be associated with service policies (separate endpoint). The service policy has configuration and information which applies to all associated subscriptions.
Path Parameters
- servicePolicyId string required
Possible values: Value must match regular expression
^22[A-HJ-NP-Z2-9]{6}$Service policy ID to perform request on.
Query Parameters
- include string[]
Possible values: [
cmpServicePolicy]Related resources to include in response. Format as a comma separated list. Omitting this query parameter means that no related resources will be included in response. Note that including resources may result in longer response times so only include what you actually need.
- 200
- 400
- 401
- 403
- 404
- 500
Contains the requested service policy.
- application/json
- Schema
- Example (from schema)
Schema
attributes object
id stringPossible values: Value must match regular expression
^22[A-HJ-NP-Z2-9]{6}$Identifies the service policy.
domainId stringPossible values: Value must match regular expression
^([A-Za-z0-9]{8}-){0,6}[A-Za-z0-9]{8}$Domain the resource belongs to. Used to determine which users have access to the resource.
name stringPossible values:
non-emptyand<= 256 charactersName of the service policy.
type stringPossible values: [
IOTA_SERVICE_POLICY,ARQIA_SERVICE_POLICY,THINGSPACE_SERVICE_POLICY]Specifies the underlying service policy type in the Connectivity Management Platform (CMP).
metadata object
All metadata key-value pairs associated with this service policy. This object contains dynamic properties since metadata has a customized definition process.
relationships object
cmpServicePolicy object
anyOf- MOD1
- MOD2
url stringPossible values:
non-emptyand<= 256 charactersattributes object
Attributes used to describe an IoTA subscription package.
id stringId of the service policy on the CMP instance
description stringThe subscription package's description in IoTA.
services object
bearerServices object
2g3g boolean2G and 3G.
lte booleanLong Term Evolution.
smsMo booleanSMS Mobile Originated.
smsMt booleanSMS Mobile Terminated.
voice booleanlteRadioAccessTechnologyRestrictions object
2g boolean3g booleanlte booleanLong Term Evolution.
nbIot booleanNarrowband Internet of Things.
5g booleansupplementaryServices object
baoc booleanBarring of all outgoing calls.
baic booleanBarring of all incoming calls.
boic booleanBarring of outgoing international calls.
ard stringPossible values: [
NO_RESTRICTIONS,2G_BLOCKED,3G_BLOCKED,4G_BLOCKED]Access data restriction.
obopre booleanBarring of outgoing premium rate calls (entertainment).
apns object[]
apnName stringPossible values: Value must match regular expression
^[a-zA-Z0-9.]{3,256}$roamingProfiles object
2g3g object
id stringPossible values:
non-emptyand<= 64 charactersdescription stringPossible values:
<= 256 charactersConnexion 953
lte object
id stringPossible values:
non-emptyand<= 64 charactersdescription stringPossible values:
<= 256 charactersConnexion 954 LTE
version stringPossible values: [
v1,v2]url stringPossible values:
non-emptyand<= 256 charactersattributes object
Attributes used to describe an Arqia plano.
id stringIdentifies the plano in Arqia.
description stringThe plano's description in Arqia.
{
"attributes": {
"id": "22A8BC76",
"domainId": "a1ce25s2-c23edcs9",
"name": "5MB Europe",
"type": "IOTA_SERVICE_POLICY",
"metadata": {
"Info": "LTE allowed but no voice"
}
},
"relationships": {
"cmpServicePolicy": {
"url": "/iot-connect/service-policies/v1/iota/iota_eu/E1245_SP_02"
}
}
}
BadRequest
Response Headers
Access-Control-Allow-Origin string
Access-Control-Allow-Methods string
Access-Control-Allow-Headers string
- application/json
- Schema
- Example (from schema)
Schema
- name string
- message string
errors object[]
message stringerrorCode stringpath stringOptional path, usually used to describe which incoming parameters are not valid.
{
"name": "string",
"message": "string",
"errors": [
{
"message": "string",
"errorCode": "string",
"path": "string"
}
]
}
Unauthorized. Your token is not valid.
Response Headers
Access-Control-Allow-Origin string
Access-Control-Allow-Methods string
Access-Control-Allow-Headers string
- application/json
- Schema
- Example (from schema)
Schema
- name string
- message string
errors object[]
message stringerrorCode stringpath stringOptional path, usually used to describe which incoming parameters are not valid.
{
"name": "string",
"message": "string",
"errors": [
{
"message": "string",
"errorCode": "string",
"path": "string"
}
]
}
Forbidden. You are not allowed to access the requested resource.
Response Headers
Access-Control-Allow-Origin string
Access-Control-Allow-Methods string
Access-Control-Allow-Headers string
- application/json
- Schema
- Example (from schema)
Schema
- name string
- message string
errors object[]
message stringerrorCode stringpath stringOptional path, usually used to describe which incoming parameters are not valid.
{
"name": "string",
"message": "string",
"errors": [
{
"message": "string",
"errorCode": "string",
"path": "string"
}
]
}
The specified resource was not found
Response Headers
Access-Control-Allow-Origin string
Access-Control-Allow-Methods string
Access-Control-Allow-Headers string
- application/json
- Schema
- Example (from schema)
Schema
- name string
- message string
errors object[]
message stringerrorCode stringpath stringOptional path, usually used to describe which incoming parameters are not valid.
{
"name": "string",
"message": "string",
"errors": [
{
"message": "string",
"errorCode": "string",
"path": "string"
}
]
}
Internal Server Error
Response Headers
Access-Control-Allow-Origin string
Access-Control-Allow-Methods string
Access-Control-Allow-Headers string
- application/json
- Schema
- Example (from schema)
Schema
- name string
- message string
errors object[]
message stringerrorCode stringpath stringOptional path, usually used to describe which incoming parameters are not valid.
{
"name": "string",
"message": "string",
"errors": [
{
"message": "string",
"errorCode": "string",
"path": "string"
}
]
}