ECS Address Provision Configurations

/{afId}/configurations

GET

Read all configurations for a given AF identified by {afId}

POST

Create a new configuration to provision ECS address(es)

Individual ECS Address Provision Configuration

/{afId}/configurations/{configurationId}

GET

Read an existing configuration identified by {configurationId}

PUT

Modify all of the properties of an existing configuration identified by {configurationId}

DELETE

Delete a configuration identified by {configurationId}

apiRoot

string

Clause 5.2.4 of 3GPP TS 29.122 [4].

afId

string

Identifier of the AF.

N/A

N/A

array(EcsAddressProvision)

M

0..N

200 OK

All the configurations for the AF are returned.

N/A

307 Temporary Redirect

Temporary redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

EcsAddressProvision

M

1

Parameters to create a confirguation to provision ECS address.

EcsAddressProvision

M

1

201 Created

The configuration was created successfully.

The URI of the created resource shall be returned in the "Location" HTTP header.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-ecs-address-provision/v1/{afId}/configurations/{configurationId}

apiRoot

string

Clause 5.2.4 of 3GPP TS 29.122 [4].

afId

string

Identifier of the AF.

configurationId

string

Identifier of the configuration resource.

N/A

N/A

EcsAddressProvision

M

1

200 OK

The information for the configuration in the request URI are returned.

N/A

307 Temporary Redirect

Temporary redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

EcsAddressProvision

M

1

Replace an existing Individual ECS Address Provision Configuration.

EcsAddressProvision

M

1

200 OK

The configuration was updated successfully.

N/A

204 No Content

The configuration was updated successfully.

N/A

307 Temporary Redirect

Temporary redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

N/A

N/A

N/A

204 No Content

The configuration was terminated successfully.

N/A

307 Temporary Redirect

Temporary redirection, during configuration termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during configuration termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

EcsAddressProvision

5.16.2.3.2

Represents ECS address provision configuration information.

EcsServerAddr

3GPP TS 29.571 [8]

Link

3GPP TS 29.122 [4]

Identifies a referenced resource.

SpatialValidityCond

3GPP TS 29.571 [8]

SupportedFeatures

3GPP TS 29.571 [8]

Used to negotiate the applicability of the optional features defined in table 5.16.3-1.

self

Link

C

0..1

Identifies the individual configuration resource.

Shall be present in the HTTP GET response when reading all the configurations for an AF.

ecsServerAddr

EcsServerAddr

M

1

Represents the ECS address(es).

spatialValidityCond

SpatialValidityCond

O

0..1

Spatial validity condition.

tgtUe

TargetUeId

O

0..1

Target UE information.

suppFeat

SupportedFeatures

M

1

Indicates the negotiated supported features.

Application AM Contexts

/{afId}/app-am-contexts

POST

Create a new Individual application AM context resource and may create the child AM Policy Events Subscription sub-resource.

Individual application AM Context

/{afId}/app-am-contexts/{appAmContextId}

GET

Reads an existing Individual application AM context resource.

PATCH

Updates an existing Individual application AM context resource. It can also create or update an AM Policy Events Subscription sub-resource.

DELETE

Deletes an existing Individual application AM context resource and the child AM Policy Events Subscription sub-resource.

AM Policy Events Subscription

/{afId}/app-am-contexts/{appAmContextId}/events-subscription

PUT

Creates a new AM Policy Events Subscription sub-resource or modifies an existing AM Policy Events Subscription sub-resource.

DELETE

Deletes an AM Policy Events Subscription sub-resource.

apiRoot

string

Clause 5.2.4 of 3GPP TS 29.122 [4].

afId

string

Identifier of the AF.

AppAmContextExpData

M

1

Contains the exposure information for the creation of a new Individual application AM context resource.

AppAmContextExpRespData

M

1

201 Created

Successful case.

The Individual application AM context resource was created successfully.

The URI of the created resource shall be returned in the "Location" HTTP header.

ProblemDetails

O

0..1

500 Internal Server Error

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

NOTE 2: Failure causes are described in clause 5.17.5.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-am-policyauthorization/v1/{afId}/ app-am-contexts/{appAmContextId}

apiRoot

string

Clause 5.2.4 of 3GPP TS 29.122 [4].

afId

string

Identifier of the AF.

appAmContextId

string

Identifier of the application AM context formatted according to IETF RFC 3986 [44].

N/A

N/A

AppAmContextExpData

M

1

200 OK

Successful case.

The exposure information of an existing Individual application AM context in the request URI is returned.

N/A

307 Temporary Redirect

Temporary redirection, during the AM context retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during the AM context retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

NOTE 2: Failure causes are described in clause 5.17.5.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

n/a

AppAmContextExpUpdateData

M

1

Contains the modification(s) to be applied to the Individual application AM context resource.

AppAmContextExpRespData

M

1

200 OK

Successful case.

The exposure information of the updated application AM context.

N/A

204 No Content

The application AM context was updated successfully.

N/A

307 Temporary Redirect

Temporary redirection, during the AM context modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during the AM context modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

ProblemDetails

O

0..1

400 Bad Request

(NOTE 2)

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

NOTE 2: Failure causes are described in clause 5.17.5.

Location

String

M

1

An alternative URI of the resource located in an alternative NEF.

Location

String

M

1

An alternative URI of the resource located in an alternative NEF.

N/A

N/A

N/A

204 No Content

Successful case.

The application AM context was terminated successfully.

N/A

307 Temporary Redirect

Temporary redirection, during the AM context termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during the AM context termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

NOTE 2: Failure causes are described in clause 5.17.5.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

apiRoot

string

Clause 5.2.4 of 3GPP TS 29.122 [4].

afId

string

Identifier of the AF.

appAmContextId

string

Identifier of the application AM context formatted according to IETF RFC 3986 [44].

N/A

AmEventsSubscData

M

1

Contains the information for the creation and/or modification of the AM Policy Events Subscription.

AmEventsSubscRespData

M

1

201 Created

Successful case.

The AM policy events subscription sub-resource was created. The representation of the AM Policy Events Subscription sub-resource is included within the properties of the AmEventsSubscData data type. The one or more matched events, if available, are included within the properties of the AmEventsNotification data type.

AmEventsSubscRespData

M

1

200 OK

Successful case.

The AM policy events subscription sub-resource was modified and a representation of the sub-resource is returned. The representation of the AM Policy Events Subscription sub-resource is included within the properties of the AmEventsSubscData data type. The one or more matched events, if available, are included within the properties of the AmEventsNotification data type.

N/A

204 No Content

Successful case.

The AM policy events subscription sub-resource was modified successfully, with no content to be sent in the response message body.

N/A

307 Temporary Redirect

Temporary redirection, during the AM policy events subscription or modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during the AM policy events subscription or modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

NOTE 2: Failure causes are described in clause 5.17.5.

Location

String

M

1

Contains the URI of the resource in which an AM policy events subscription sub-resource has been created, according to the structure:
{apiRoot}/3gpp-am-policyauthorization/v1/{afId}/app-am-contexts/{appAmContextId}/events-subscription

Location

String

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

N/A

N/A

N/A

204 No Content

Successful case.

The AM policy event(s) subscription resource is deleted.

N/A

307 Temporary Redirect

Temporary redirection, during the AM policy events deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during the AM policy events deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

NOTE 2: Failure causes are described in clause 5.17.5.

Location

String

M

1

An alternative URI of the resource located in an alternative NEF.

Location

String

M

1

An alternative URI of the resource located in an alternative NEF.

AM Event Notification

{eventNotifUri}

POST

The AM policy changes event notification is provided by the NEF to the AF.

eventNotifUri

Callback reference provided by the AF during creation/modification of the subscription within the AM policy events subscription sub-resource as defined in Table 5.17.3.3.2-1 or Table 5.17.3.3.3-1 or Table 5.6.2.4-1 of 3GPP TS 29.534 [43].

AmEventsNotification

M

1

Provides information about the observed access and mobility policy change events by the NEF to the AF.

N/A

204 No Content

The event notification is received successfully.

N/A

307 Temporary Redirect

Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Location

String

M

1

An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

Location

String

M

1

An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

AppAmContextExpData

5.17.3.3.2

Represents an Individual application AM context exposure resource.

AppAmContextExpRespData

5.17.3.5.1

Represents a response to a modification or creation request of an Individual Application AM context resource. It may contain the notification of the already met events.

AppAmContextExpUpdateData

5.17.3.3.3

Contains the modification(s) to be applied to the Individual application AM context exposure resource.

GeographicalArea

5.17.3.3.4

Contains geographical area information (e.g. a civic address or shapes).

AmEventsNotification

3GPP TS 29.534 [43]

Describes the notification about the events occurred within an Individual application AM context resource.

AmEventsSubscData

3GPP TS 29.534 [43]

Identifies the AM policy events the application subscribes to.

AmEventsSubscDataRm

3GPP TS 29.534 [43]

This data type is defined in the same way as the "AmEventsSubscData" data type, but with the OpenAPI "nullable: true" property.

AmEventsSubscRespData

3GPP TS 29.534 [43]

It represents a response to an AM policy events subscription request and contains the created/updated AM Policy Events Subscription resource. It may also include the Notification of the events met at the time of subscription.

CivicAddress

3GPP TS 29.572 [34]

Identifies the civic address.

DurationSec

3GPP TS 29.122 [4]

Indicates the time duration.

DurationSecRm

3GPP TS 29.122 [4]

Indicates the time duration, same as the "DurationSec" data type, but with the OpenAPI "nullable: true" property.

GeographicArea

3GPP TS 29.572 [34]

Identifies the geographical information with shapes.

Gpsi

3GPP TS 29.571 [8]

Identifies a GPSI.

Link

3GPP TS 29.122 [4]

Identifies a referenced resource.

SupportedFeatures

3GPP TS 29.571 [8]

Used to negotiate the applicability of the optional features defined in table 5.17.4-1.

WebsockNotifConfig

3GPP TS 29.122 [4]

Contains the configuration parameters to set up notification delivery over Websocket protocol.

self

Link

C

0..1

Identifies the individual configuration resource.

Shall be present in the HTTP GET response when reading all the configurations for an AF.

evSubscs

AmEventsSubscData

O

0..1

Represents the subscription to one or more AM policy events.

gpsi

Gpsi

M

1

Identifies the GPSI.

highThruInd

boolean

C

0..1

Indicates whether high throughput is desired for the indicated UE traffic. Set to "true" if high throughput is desired; otherwise set to "false". Default value is "false" if omitted. (NOTE)

covReqs

array(GeographicalArea)

C

1..N

Identifies the allowed geographical areas. (NOTE)

policyDuration

DurationSec

O

0..1

Indicates the time duration that the policy shall last.

suppFeat

SupportedFeatures

C

0..1

Indicates the negotiated supported features..

It shall be supplied by the AF in the POST request that requests a creation of an Individual application AM context resource.

It shall be supplied by the NEF in the response to the POST request that requests a creation of an Individual application AM context resource.

requestTestNotification

boolean

O

0..1

Set to true by the AF to request the NEF to send a test notification as defined in clause 5.2.5.3 of 3GPP TS 29.122 [4]. Set to false or omitted otherwise.

Notification_test_event

websockNotifConfig

WebsockNotifConfig

O

0..1

Configuration parameters to set up notification delivery over Websocket protocol.

Notification_websocket

NOTE: Either "highThruInd" attribute or "covReqs" attribute or both shall be included.

evSubscs

AmEventsSubscDataRm

O

0..1

Represents the subscription to one or more AM policy events.

highThruInd

boolean

O

0..1

Indicates whether high throughput is desired for the indicated UE traffic. Set to "true" if high throughput is desired; otherwise set to "false".

covReqs

array(GeographicalArea)

O

1..N

Identifies the allowed geographical areas. (NOTE)

policyDuration

DurationSecRm

O

0..1

Indicates the time duration that the policy shall last.

NOTE: The value of the property shall be set to NULL for removal.

civicAddress

CivicAddress

C

0..1

Identifies a civic address.

shapes

GeographicArea

C

0..1

Identifies a geographic area specified by different shapes.

NOTE: One of "civicAddress" attribute or "shapes" attribute shall be included.

AmEventsNotification

0..1

It represents the notification of a match event during the creation or modification of the Individual application AM context data.

AppAmContextExpData

1

It represents the Individual application AM context resource.

1

Notification_websocket

The delivery of notifications over Websocket is supported as described in 3GPP TS 29.122 [4]. This feature requires that the Notification_test_event feature is also supported.

2

Notification_test_event

The testing of notification connection is supported as described in 3GPP TS 29.122 [4].

INVALID_POLICY_REQUEST

400 Bad Request

The HTTP request is rejected because the service information for the AM context is invalid or insufficient for the PCF to perform the requested action.

APPLICATION_AM_CONTEXT_NOT_FOUND

404 Not Found

The HTTP request is rejected because the specified Individual Application AM Context does not exist.

POLICY_ASSOCIATION_NOT_AVAILABLE

500 Internal Server Error

The PCF failed in executing binding with the UE/AM Policy Context.