5.10 CpProvisioning API
29.1223GPPRelease 18T8 reference point for Northbound APIsTS
5.10.1 Overview
The CpProvisioning API is a RESTful API that allows the SCS/AS to add, change or delete the communication pattern parameter sets of the UE. The CpProvisioning API defines a set of data models, resources and the related procedures for the creation and management of the resources for communication pattern parameter provisioning. The corresponding JSON schema for the representation of the resources and operations defined by the CpProvisioning API is provided in its complete form in Annex A.10.
5.10.2 Data model
5.10.2.1 Resource data types
5.10.2.1.1 Introduction
This clause defines data structures to be used in resource representations.
Table 5.10.2.1.1-1 specifies data types re-used by the CpProvisioning API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the CpProvisioning API.
Table 5.10.2.1.1-1: CpProvisioning API re-used Data Types
Data type |
Reference |
Comments |
Dnn |
3GPP TS 29.571 [45] |
Identifies a DNN. |
IpAddr |
3GPP TS 29.571 [45] |
UE IP Address. |
MacAddr48 |
3GPP TS 29.571 [45] |
MAC Address. |
NetworkAreaInfo |
3GPP TS 29.554 [50] |
Identifies a network area information. |
Snssai |
3GPP TS 29.571 [45] |
Identifies the S-NSSAI. |
SupportedFeatures |
3GPP TS 29.571 [45] |
Used to negotiate the applicability of the optional features defined in table 5.10.4-1. |
Table 5.10.2.1.1-2 specifies the data types defined for the CpProvisioning API.
Table 5.10.2.1.1-2: CpProvisioning API specific Data Types
Data type |
Clause defined |
Description |
Applicability |
BatteryIndication |
5.10.2.3.6 |
Represents the type of power consumption. |
|
CommunicationIndicator |
5.10.2.3.3 |
Represents the communication type used by the UE. |
|
CpFailureCode |
5.10.2.3.5 |
Represents the failure reason of the CP parameter provisioning. |
|
CpInfo |
5.10.2.1.2 |
Represents the resources for communication pattern parameter provisioning. |
|
CpParameterSet |
5.10.2.2.2 |
Represents an offered communication pattern parameter set. |
|
CpReport |
5.10.2.2.4 |
Represents a CP report indicating the CP set identifier(s) which CP parameter(s) are not added or modified successfully and the corresponding failure cause(s). |
|
ScheduledCommunicationTime |
5.10.2.2.3 |
Represents an offered scheduled communication time. |
|
ScheduledCommunicationType |
5.10.2.3.8a |
Represents the type of scheduled communication. |
ScheduledCommType_5G |
StationaryIndication |
5.10.2.3.4 |
Indicates whether the UE is stationary or mobile. |
|
TrafficProfile |
5.10.2.3.7 |
Represents the type of data transmission. |
|
UmtLocationArea5G |
5.10.2.2.5 |
Represents the user location area describing the UE moving trajectory. |
ExpectedUMT_5G, ExpectedUmtTime_5G |
5.10.2.1.2 Type: CpInfo
This type represents the resources for communication pattern parameter provisioning. The same structure is used in the subscription request and subscription response.
Table 5.10.2.1.2-1: Definition of type CpInfo
Attribute name |
Data type |
Cardinality |
Description |
Applicability (NOTE 2) |
self |
Link |
0..1 |
Link to the resource "Individual CP Provisioning Subscription". This parameter shall be supplied by the SCEF in HTTP responses. |
|
supportedFeatures |
SupportedFeatures |
0..1 |
Used to negotiate the supported optional features of the API as described in clause 5.2.7. This attribute shall be provided in the POST request and in the response of successful resource creation. |
|
mtcProviderId |
string |
0..1 |
Identifies the MTC Service Provider and/or MTC Application. (NOTE 3) |
|
dnn |
Dnn |
0..1 |
Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. |
UEId_retrieval |
externalId |
ExternalId |
0..1 |
Each element uniquely identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2]. The attribute may also be present in the CP provisioning subscription response message, if the "UEId_retrieval" feature is supported and the corresponding request message includes the "ueIpAddr" attribute or the "ueMacAddr" attribute. (NOTE 1) |
|
msisdn |
Msisdn |
0..1 |
Each element identifies the MS internal PSTN/ISDN number allocated for a UE. (NOTE 1) |
|
externalGroupId |
ExternalGroupId |
0..1 |
Identifies a user group as defined in Clause 4.6.2 of 3GPP TS 23.682 [2]. (NOTE 1) |
|
cpParameterSets |
map(CpParameterSet) |
1..N |
Identifies a set of CP parameter information that may be part of this CpInfo structure. Any string value can be used as a key of the map. |
|
cpReports |
map(CpReport) |
0..N |
Supplied by the SCEF and contains the CP set identifiers for which CP parameter(s) are not added or modified successfully. The failure reason is also included. Each element provides the related information for one or more CP set identifier(s) and is identified in the map via the failure identifier as key. (NOTE 4). |
|
snssai |
Snssai |
0..1 |
Indicate the S-NSSAI. |
UEId_retrieval |
ueIpAddr |
IpAddr |
0..1 |
UE IP address. |
UEId_retrieval |
ueMacAddr |
MacAddr48 |
0..1 |
UE MAC address. |
UEId_retrieval |
NOTE 1: One of the properties "externalId", "msisdn" or "externalGroupId" shall be included. NOTE 2: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. NOTE 3: The SCEF should check received MTC provider identifier and then the SCEF may: NOTE 4: The failure identifier is a string encoded map key. |
5.10.2.2 Referenced structured data types
5.10.2.2.1 Introduction
This clause defines structured data types that are referenced from data structures defined in the previous clauses.
5.10.2.2.2 Type: CpParameterSet
This data type represents an offered communication pattern parameter set sent from the SCC/AS to the SCEF.
Table 5.10.2.2.2-1: Definition of type CpParameterSet
Attribute name |
Data type |
Cardinality |
Description |
Applicability (NOTE 1) |
setId |
string |
1 |
SCS/AS-chosen correlator provided by the SCS/AS in the request to create a resource fo CP parameter set(s). (NOTE 4) |
|
self |
Link |
0..1 |
Link to the resource "Individual CP set Provisioning". This parameter shall be supplied by the SCEF in HTTP responses. |
|
validityTime |
DateTime |
0..1 |
Identifies when the CP parameter set expires and shall be deleted. If absent, it indicates that there is no expiration time for this CP parameter set. |
|
periodicCommunicationIndicator |
CommunicationIndicator |
0..1 |
Identifies whether UE communicates periodically or on demand. |
|
communicationDurationTime |
DurationSec |
0..1 |
Identifies duration time of periodic communication |
|
periodicTime |
DurationSec |
0..1 |
Identifies interval time of periodic communication |
|
scheduledCommunicationTime |
ScheduledCommunicationTime |
0..1 |
Identifies time zone and day of the week when the UE is available for communication. |
|
scheduledCommunicationType |
ScheduledCommunicationType |
0..1 |
Indicates the Scheduled Communication Type. May only be present if the "scheduledCommunicationTime" attribute is provided. |
ScheduledCommType_5G |
stationaryIndication |
StationaryIndication |
0..1 |
Identifies whether the UE is stationary or mobile. |
|
batteryInds |
array(BatteryIndication) |
0..N |
Indicates the power consumption type(s) of the UE. (NOTE 3) |
|
trafficProfile |
TrafficProfile |
0..1 |
Identifies the type of data transmission. |
|
expectedUmts |
array(UmtLocationArea5G) |
0..N |
Identifies the UE’s expected geographical movement. The attribute is only applicable in 5G. (NOTE 2) |
ExpectedUMT_5G ExpectedUmtTime_5G |
expectedUmtDays |
array(DayOfWeek) |
0..6 |
Identifies the day(s) of the week. If absent, it indicates every day of the week. |
ExpectedUmtTime_5G |
NOTE 1: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. NOTE 2: The first instance of the attribute represents the start of the location, and the last one represents the stop of the location. NOTE 3: If "BATTERY_RECHARGE" is provided, "BATTERY_NO_RECHARGE" shall not be provided simultaneously, vice versa; If "BATTERY_REPLACE" is provided, "BATTERY_NO_REPLACE" shall not be provided simultaneously, vice versa; If "NO_BATTERY" is provided, any value indicating UE powered with battery shall not be provided simultaneously, vice versa. NOTE 4: A setId can only belong to one "Individual CP Provisioning Subscription" resource. |
5.10.2.2.3 Type: ScheduledCommunicationTime
This data type represents an offered scheduled communication time.
Table 5.10.2.2.3-1: Definition of type ScheduledCommunicationTime
Attribute name |
Data type |
Cardinality |
Description |
Applicability (NOTE) |
daysOfWeek |
array(DayOfWeek) |
0..6 |
Identifies the day(s) of the week. If absent, it indicates every day of the week. |
|
timeOfDayStart |
TimeOfDay |
0..1 |
Identifies the start time of the day. |
|
timeOfDayEnd |
TimeOfDay |
0..1 |
Identifies the end time of the day. |
|
NOTE: Properties marked with a feature as defined in subclause 5.10.4 are applicable as described in subclause 5.2.7. If no features are indicated, the related property applies for all the features. |
5.10.2.2.4 Type: CpReport
This type represents a CP report to indicate the CP set identifier(s) which CP parameter(s) are not added or modified successfully and corresponding failure reason.
Table 5.10.2.2.4-1: Definition of type CpReport
Attribute name |
Data type |
Cardinality |
Description |
Applicability (NOTE) |
setIds |
array(string) |
0..N |
Identifies the CP set identifier(s) which CP parameter(s) are not added or modified successfully |
|
failureCode |
CpFailureCode |
1 |
Identifies the failure reason |
|
NOTE: Properties marked with a feature as defined in subclause 5.10.4 are applicable as described in subclause 5.2.7. If no features are indicated, the related property applies for all the features. |
5.10.2.2.5 Type: UmtLocationArea5G
This data type represents the user location area describing the UE moving trajectory which is sent from the AF.
Table 5.10.2.2.5-1: Definition of the UmtLocationArea5G data Type
Attribute name |
Data type |
Cardinality |
Description |
Applicability (NOTE 1) |
umtTime |
TimeOfDay |
0..1 |
This IE identifies the time of the day when the UE arrives the location. |
ExpectedUmtTime_5G |
umtDuration |
DurationSec |
0..1 |
This IE identifies the time duration the UE stays in the location. |
ExpectedUmtTime_5G |
NOTE 1: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. NOTE 2: This data type also contains all the properties defined for LocationArea5G data type, these properties are applicable for ExpectedUMT_5G. |
5.10.2.3 Referenced simple data types and enumerations
5.10.2.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. In addition, data types and enumerations defined in clause 5.2.1 can be referenced.
5.10.2.3.2 Simple data types
The simple data types defined in table 5.10.2.3.2-1 shall be supported.
Table 5.10.2.3.2-1: Simple data types
Type name |
Description |
5.10.2.3.3 Enumeration: CommunicationIndicator
Table 5.10.2.3.3-1: Enumeration CommunicationIndicator
Enumeration value |
Description |
Applicability (NOTE) |
PERIODICALLY |
Identifies the UE communicates periodically |
|
ON_DEMAND |
Identifies the UE communicates on demand |
|
NOTE: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. |
5.10.2.3.4 Enumeration: StationaryIndication
Table 5.10.2.3.4-1: Enumeration StationaryIndication
Enumeration value |
Description |
Applicability (NOTE) |
STATIONARY |
Identifies the UE is stationary |
|
MOBILE |
Identifies the UE is mobile |
|
NOTE: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. |
5.10.2.3.5 Enumeration: CpFailureCode
The enumeration FailureCode represents the failure reason of the CP parameter provisioning.
Table 5.10.2.3.5-1: Enumeration CpFailureCode
Enumeration value |
Description |
Applicability (NOTE) |
MALFUNCTION |
This value indicates that something functions wrongly in CP parameter provisioning or the CP parameter provisioning does not function at all. |
|
SET_ID_DUPLICATED |
The received CP set identifier(s) are already provisioned. |
|
OTHER_REASON |
Other reason unspecified. |
|
NOTE: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. |
5.10.2.3.6 Enumeration: BatteryIndication
The enumeration BatteryIndication represents the type of power consumption.
Table 5.10.2.3.6-1: Enumeration BatteryIndication
Enumeration value |
Description |
Applicability (NOTE) |
BATTERY_RECHARGE |
UE powered with rechargeable battery. |
|
BATTERY_REPLACE |
UE powered with replaceable battery. |
|
BATTERY_NO_RECHARGE |
UE powered with no rechargeable battery. |
|
BATTERY_NO_REPLACE |
UE powered with no replaceable battery. |
|
NO_BATTERY |
UE not battery powered. |
|
NOTE: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. |
5.10.2.3.7 Enumeration: TrafficProfile
The enumeration TrafficProfile represents the type of data transmission.
Table 5.10.2.3.7-1: Enumeration TrafficProfile
Enumeration value |
Description |
Applicability (NOTE) |
SINGLE_TRANS_UL |
Uplink single packet transmission. |
|
SINGLE_TRANS_DL |
Downlink single packet transmission. |
|
DUAL_TRANS_UL_FIRST |
Dual packet transmission, firstly uplink packet transmission with subsequent downlink packet transmission. |
|
DUAL_TRANS_DL_FIRST |
Dual packet transmission, firstly downlink packet transmission with subsequent uplink packet transmission. |
|
MULTI_TRANS |
Multiple packet transmission. |
|
NOTE: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. |
5.10.2.3.8A Enumeration: ScheduledCommunicationType
The enumeration ScheduledCommunicationType represents the type of scheduled communication.
Table 5.10.2.3.8A-1: Enumeration ScheduledCommunicationType
Enumeration value |
Description |
DOWNLINK |
Downlink only |
UPLINK |
Uplink only |
BIDIRECTIONAL |
Bi-directional |
5.10.3 Resource structure
5.10.3.1 General
All resource URIs of this API should have the following root:
{apiRoot}/3gpp-cp-parameter-provisioning/v1
"apiRoot" is set as described in clause 5.2.4. All resource URIs in the clauses below are defined relative to the above root URI.
The following resources and HTTP methods are supported for this API:
Table 5.10.3.1-1: Resources and methods overview
Resource name |
Resource URI |
HTTP method |
Meaning |
CP provisioning Subscriptions |
/{scsAsId}/subscriptions |
GET |
Read all active CP parameter provisioning subscription resources for a given SCS/AS. |
POST |
Create a new subscription resource of provisioning CP parameter set(s). |
||
Individual CP Provisioning Subscription |
/{scsAsId}/subscriptions/{subscriptionId} |
GET |
Read a CP parameter provisioning subscription resource. |
PUT |
Modify a CP parameter provisioning subscription resource. |
||
DELETE |
Delete a CP parameter provisioning subscription resource. |
||
Individual CP set Provisioning |
/{scsAsId}/subscriptions/{subscriptionId}/cpSets/{setId} (NOTE 1, NOTE 2) |
PUT |
Update CP at individual CP set(s) level associated with a CP parameter set Id. |
GET |
Read CP at individual CP set(s) level associated with a CP parameter set Id. |
||
DELETE |
Delete CP at individual CP set(s) level associated with a CP parameter set Id. |
||
NOTE 1: This setId as a resource identifier is not necessarily identical as the CP parameter set Id received from the SCS/AS. NOTE 2: The path segment "cpSets" does not follow the related naming convention defined in clause 5.2.4. The path segment is however kept as currently defined in this specification for backward compatibility considerations. |
5.10.3.2 Resource: CP Provisioning Subscriptions
5.10.3.2.1 Introduction
This resource allows the SCS/AS to read all active long-term transactions related to CP parameter provisioning resource management.
5.10.3.2.2 Resource definition
Resource URI: {apiRoot}/3gpp-cp-parameter-provisioning/v1/{scsAsId}/subscriptions
This resource shall support the resource URI variables defined in table 5.10.3.2.2-1.
Table 5.10.3.2.2-1: Resource URI variables for resource "CP Provisioning Subscriptions"
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.2.4. |
scsAsId |
string |
Identifier of the SCS/AS. |
5.10.3.2.3 Resource methods
5.10.3.2.3.1 GET
The GET method allows to read all active subscriptions for a given SCS/AS. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message.
This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.10.3.2.3.1-1 and table 5.10.3.2.3.1-2.
Table 5.10.3.2.3.1-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
Cardinality |
Remarks |
none specified |
Table 5.10.3.2.3.1-2: Data structures supported by the GET request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
none |
||||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
array(CpInfo) |
0..N |
200 OK |
The subscription information related to the request URI is returned. |
|
none |
307 Temporary Redirect |
Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. |
Table 5.10.3.2.3.1-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
Table 5.10.3.2.3.1-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
5.10.3.2.3.2 PUT
This HTTP method is not supported for the resource.
5.10.3.2.3.3 PATCH
This HTTP method is not supported for the resource.
5.10.3.2.3.4 POST
The POST method allows to create subscription for a given SCS/AS. The SCS/AS shall initiate the HTTP POST request message and the SCEF shall respond to the message.
This method shall support request and response data structures, and response codes, as specified in the table 5.10.3.2.3.4-1.
Table 5.10.3.2.3.4-1: Data structures supported by the POST request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
CpInfo |
1 |
Change information in CP parameter set. |
||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
CpInfo |
1 |
201 Created |
The subscription was created successfully. The SCEF shall return the created subscription in the response payload body. CpReport may be included to provide detailed failure information for some CP sets. |
|
array(CpReport) |
1..N |
500 Internal Server Error |
The CP parameters for all CP sets were not created successfully. CpReport is included with detailed information. |
|
ProblemDetails |
0..1 |
403 Forbidden |
(NOTE 2) |
|
ProblemDetails |
0..1 |
404 Not Found |
(NOTE 2) |
|
NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. NOTE 2: Failure causes are described in clause 5.10.5. |
Table 5.10.3.2.3.4-2: Headers supported by the 201 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-cp-parameter-provisioning/v1/{scsAsId}/subscriptions/{subscriptionId} |
5.10.3.2.3.5 DELETE
This HTTP method is not supported for the resource.
5.10.3.3 Resource: Individual CP Provisioning Subscription
5.10.3.3.1 Introduction
This resource allows the SCS/AS to manage resources for CP parameter provisioning using a subscription Id.
5.10.3.3.2 Resource definition
Resource URI: {apiRoot}/3gpp-cp-parameter-provisioning/v1/{scsAsId}/subscriptions/{subscriptionId}
This resource shall support the resource URI variables defined in table 5.10.3.3.2-1.
Table 5.10.3.3.2-1: Resource URI variables for resource "Individual CP Provisioning Subscription"
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.2.4. |
scsAsId |
string |
Identifier of the SCS/AS. |
subscriptionId |
string |
Identifier of the subscription resource. The subscriptionId corresponds to the stage 2 TLTRI. |
5.10.3.3.3 Resource methods
5.10.3.3.3.1 GET
The GET method allows to read the subscription for a given SCS/AS and subscription Id. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message.
This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.10.3.3.3.1-1 and table 5.10.3.3.3.1-2.
Table 5.10.3.3.3.1-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
Cardinality |
Remarks |
none specified |
Table 5.10.3.3.3.1-2: Data structures supported by the GET request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
none |
||||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
CpInfo |
1 |
200 OK |
The subscription information related to the request URI is returned. |
|
none |
307 Temporary Redirect |
Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. |
Table 5.10.3.3.3.1-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
Table 5.10.3.3.3.1-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
5.10.3.3.3.2 PUT
The PUT method allows to change (add/update/remove) one ore more CP parameter set(s) resource(s). The SCS/AS shall initiate the HTTP PUT request message and the SCEF shall respond to the message.
This method shall support request and response data structures, and response codes, as specified in the table 5.14.3.3.3.2-1.
Table 5.10.3.3.3.2-1: Data structures supported by the PUT request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
CpInfo |
1 |
Change information in CP parameter set(s). |
||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
CpInfo |
1 |
200 OK |
The subscription was modified successfully. The SCEF shall return an updated subscription in the response payload body. CpReport may be included to provide detailed failure information for some CP sets. |
|
none |
204 No Content |
The subscription was modified successfully and no content is to be sent in the response message body. |
||
array(CpReport) |
1..N |
500 Internal Server Error |
The CP parameters for all CP sets were not created successfully. CpReport is included with detailed information. |
|
none |
307 Temporary Redirect |
Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. |
Table 5.10.3.3.3.2-2: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
Table 5.10.3.3.3.2-3: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
5.10.3.3.3.3 PATCH
This HTTP method is not supported for the resource.
5.10.3.3.3.4 POST
This HTTP method is not supported for the resource.
5.10.3.3.3.5 DELETE
The DELETE method allows to remove an active subscription. The SCS/AS shall initiate the HTTP DELETE request message and the SCEF shall respond to the message.
This method shall support request and response data structures, and response codes, as specified in the table 5.10.3.3.3.5-1.
Table 5.10.3.3.3.5-1.: Data structures supported by the DELETE request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
none |
||||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
none |
204 No Content |
The subscription was deleted successfully. The payload body shall be empty. |
||
none |
307 Temporary Redirect |
Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. |
Table 5.10.3.3.3.5-2: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
Table 5.10.3.3.3.5-3: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
5.10.3.4 Resource: Individual CP Set Provisioning
5.10.3.4.1 Introduction
This resource allows the SCS/AS to manage resources for CP parameter set provisioning associated with a CP parameter set Id.
5.10.3.4.2 Resource definition
Resource URI: {apiRoot}/3gpp-cp-parameter-provisioning/v1/{scsAsId}/subscriptions/{subscriptionId}/cpSets/{setId}
This resource shall support the resource URI variables defined in table 5.10.3.3.2-1.
Table 5.10.3.3.2-1: Resource URI variables for resource "Individual CP Set Provisioning"
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.2.4. |
scsAsId |
string |
Identifier of the SCS/AS. |
subscriptionId |
string |
Identifier of the subscription resource. |
setId |
string |
Identifier of the CP parameter set |
5.10.3.4.3 Resource methods
5.10.3.4.3.1 GET
The GET method allows to read a CP parameter set resource. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message.
This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.10.3.4.3.1-1 and table 5.10.3.4.3.1-2.
Table 5.10.3.4.3.1-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
Cardinality |
Remarks |
none specified |
Table 5.10.3.4.3.1-2: Data structures supported by the GET request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
none |
||||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
CpParameterSet |
1 |
200 OK |
The subscription information related to the request URI is returned. |
|
none |
307 Temporary Redirect |
Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. |
Table 5.10.3.4.3.1-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
Table 5.10.3.4.3.1-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
5.10.3.4.3.2 PUT
The PUT method allows to update a CP parameter set resource. The SCS/AS shall initiate the HTTP PUT request message and the SCEF shall respond to the message.
This method shall support request and response data structures, and response codes, as specified in the table 5.10.3.4.3.2-1.
Table 5.10.3.4.3.2-1: Data structures supported by the PUT request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
CpParameterSet |
1 |
Change information in CP parameter set. |
||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
CpParameterSet |
1 |
200 OK |
The CP parameter set resource was modified successfully. The SCEF shall return an updated CP parameter set resource in the response payload body. |
|
none |
204 No Content |
The CP parameter set resource was modified successfully and no content is to be sent in the response message body. |
||
CpReport |
1 |
409 Conflict |
The CP parameters for the CP set were not updated successfully, applicable for error SET_ID_DUPLICATED in table 5.10.2.3.5-1. |
|
CpReport |
1 |
500 Internal Server Error |
The CP parameters for the CP set were not updated successfully, applicable for other errors in table 5.10.2.3.5-1. |
|
none |
307 Temporary Redirect |
Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. |
Table 5.10.3.4.3.2-2: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
Table 5.10.3.4.3.2-3: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
5.10.3.4.3.3 PATCH
This HTTP method is not supported for the resource.
5.10.3.4.3.4 POST
This HTTP method is not supported for the resource.
5.10.3.4.3.5 DELETE
The DELETE method allows to remove an active subscription. The SCS/AS shall initiate the HTTP DELETE request message and the SCEF shall respond to the message.
This method shall support request and response data structures, and response codes, as specified in the table 5.10.3.4.3.5-1.
Table 5.10.3.4.3.5-1.: Data structures supported by the DELETE request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
none |
||||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
none |
204 No Content |
The subscription was deleted successfully. The payload body shall be empty. |
||
none |
307 Temporary Redirect |
Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. |
Table 5.10.3.4.3.5-2: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
Table 5.10.3.4.3.5-3: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
5.10.4 Used Features
The table below defines the features applicable to the CpProvisioning API. Those features are negotiated as described in clause 5.2.7.
Table 5.10.4-1: Features used by CpProvisioning API
Feature Number |
Feature |
Description |
1 |
ExpectedUMT_5G |
The UE’s expected geographical movement is supported. This feature may only be supported in 5G. |
2 |
ExpectedUmtTime_5G |
The UE’s expected geographical movement with recurrence time is supported. This feature requires the ExpectedUMT_5G feature support and may only be supported in 5G. |
3 |
ScheduledCommType_5G |
Support of scheduled communication type. This feature may only be supported in 5G. |
4 |
UEId_retrieval |
This feature supports AF specific UE ID retrieval. The feature is not applicable to pre-5G (e.g. 4G). |
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". Description: A clear textual description of the feature. |
5.10.5 Error handling
5.10.5.1 General
HTTP error handling shall be supported as specified in clause 5.2.6.
In addition, the requirements in the following clauses shall apply.
5.10.5.2 Protocol Errors
In this Release of the specification, there are no additional protocol errors applicable for the CpProvisioning API.
5.10.5.3 Application Errors
The application errors defined for CpProvisioning API are listed in table 5.10.5.3-1.
Table 5.10.5.3-1: Application errors
Application Error |
HTTP status code |
Description |
Applicability |
REQUEST_NOT_AUTHORIZED |
403 Forbidden |
Indicates that the the AF specific UE ID retrieval request is not authorized. |
UEId_retrieval |
UE_ID_NOT_AVAILABLE |
404 Not Found |
Indicates that the AF specific UE ID is not available. |
UEId_retrieval |
UE_NOT_FOUND |
404 Not Found |
Indicates that the requested UE address is not found. |
UEId_retrieval |