Ndcaf_DataReporting‌Provisioning

CreateSession

Data Reporting Provisioning Sessions collection

/sessions

POST

Provisioning AF establishes a Data Reporting Provisioning Session resource at the Data Collection AF.

RetrieveSession

Data Reporting Provisioning Session

/sessions/{sessionId}

GET

Retrieves an existing Data Reporting Provisioning Session resource from the Data Collection AF.

DestroySession

DELETE

Destroys a Data Reporting Provisioning Session resource.

CreateConfiguration

Data Reporting Configurations collection

/sessions/‌{sessionId}/‌configurations

POST

Creates a Data Reporting Configuration resource at the Data Collection AF.

RetrieveConfiguration

Data Reporting Configuration

/sessions/‌{sessionId}/‌configurations/‌{configurationId}

GET

Retrieves an existing Data Reporting Configuration resource from the Data Collection AF.

UpdateConfiguration

PUT,

PATCH

Modifies an existing Data Reporting Configuration resource at the Data Collection AF.

DestroyConfiguration

DELETE

Destroys a Data Reporting Configuration resource at the Data Collection AF.

apiRoot

string

See clause 5.2.

apiVersion

See clause 5.2.

DataReportingProvisioning‌Session

M

1

Data supplied by the Provisioning AF to enable creation of a new Data Reporting Provisioning Session at the Data Collection AF.

Authorization

string

M

1

For authentication of the Provisioning AF (see NOTE).

Origin

string

O

0..1

Indicates the origin of the requester.

NOTE: If OAuth 2.0 authorization is used the value is Bearer followed by a string representing the access token, see section 2.1 of RFC 6750 [8].

DataReportingProvisioningSession

M

1

201 Created

The creation of a Data Reporting Provisioning Session resource is confirmed by the Data Collection AF.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of TS 29.500 [9] also apply.

Location

string

M

1

The URL of the newly created resource at the Data Collection AF, according to the structure: {apiRoot}/ndcaf-data-reporting-provisioning/{apiVersion}/sessions/{sessionId}

Access-Control-Allow-Origin

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Access-Control-Allow-Methods

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: POST, PUT, DELETE

Access-Control-Expose-Headers

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: Location

apiRoot

string

See clause 5.2.

apiVersion

String

See clause 5.2

sessionId

string

Identifier of the Data Reporting Provisioning Session at the Data Collection AF.

Authorization

string

M

1

For authentication of the Provisioning AF (see NOTE).

Origin

string

O

0..1

Indicates the origin of the requester.

NOTE: If OAuth 2.0 authorization is used, the value is Bearer followed by a string representing the access token, see section 2.1 RFC 6750 [8].

DataReportingProvisioningSession

M

1

200 OK

The requested Data Reporting Provisioning Session resource is returned to the Provisioning AF by the Data Collection AF.

ProblemDetails

O

0..1

307 Temporary Redirect

Temporary redirection during a Data Reporting Session Provisioning session retrieval procedure. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance.

Applicable if the feature "ES3XX" (Extended Support of HTTP 307/308 redirection as defined in TS 29.502 [11]) is supported.

ProblemDetails

O

0..1

308 Permanent Redirect

Permanent redirection during a Data Reporting Session Provisioning session retrieval procedure. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance.

Applicable if the feature "ES3XX" is supported.

ProblemDetails

O

0..1

404 Not Found

This Data Reporting Provisioning Session resource does not exist (see NOTE 2).

NOTE 1: The mandatory HTTP error status codes for the GET method as listed in table 5.2.7.1-1 of TS 29.500 [9] also apply.

NOTE 2: Failure cases are described in subclause 6.2.4.

Access-Control-Allow-Origin

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Access-Control-Allow-Methods

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: POST, PUT, DELETE.

Access-Control-Expose-Headers

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: Location.

Location

string

M

1

An alternative URL of the resource located in another Data Collection AF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

Access-Control-Allow-Origin

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Access-Control-Allow-Methods

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: POST, PUT, DELETE

Access-Control-Expose-Headers

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: Location

Authorization

string

M

1

For authentication of the Provisioning AF (see NOTE).

Origin

string

O

0..1

Indicates the origin of the requester.)

NOTE: If OAuth 2.0 authorization is used the value is Bearer followed by a string representing the access token, see section 2.1 of RFC 6750 [8].

n/a

204 No Content

Success case: The Data Reporting Provisioning Session resource matching the sessionId was destroyed at the Data Collection AF.

ProblemDetails

O

0..1

307 Temporary Redirect

Temporary redirection during Data Reporting Provisioning Session destruction. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance.

Applicable if the feature "ES3XX" as defined in TS 29.502 [11] is supported.

ProblemDetails

O

0..1

308 Permanent Redirect

Permanent redirection during Data Reporting Provisioning Session destruction. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance.

Applicable if the feature "ES3XX" is supported.

ProblemDetails

O

0..1

404 Not Found

The Data Reporting Provisioning Session resource does not exist (see NOTE 2).

NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of TS 29.500 [9] also apply.

NOTE 2: Failure cases are described in subclause 6.2.4.

Access-Control-Allow-Origin

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Access-Control-Allow-Methods

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: POST, PUT, DELETE.

Access-Control-Expose-Headers

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: Location.

Location

string

M

1

An alternative URL of the resource located in another Data Collection AF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

Access-Control-Allow-Origin

string

O

0..1

Part of CORS [10].Supplied if the request included the Origin header.

Access-Control-Allow-Methods

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: POST, PUT, PATCH, DELETE.

Access-Control-Expose-Headers

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: Location.

apiRoot

string

See clause 5.2.

apiVersion

See clause 5.2.

sessionId

ResourceId

Identifier of the Data Reporting Provisioning Session resource at the Data Collection AF.

DataReportingConfiguration

M

1

Configuration data supplied by the Provisioning AF to the Data Collection AF regarding UE data collection and reporting by data collection clients, and subsequent event exposure by the Data Collection AF.

Authorization

string

M

1

For authentication of the Provisioning AF (see NOTE).

Origin

string

O

0..1

Indicates the origin of the requester.

NOTE: If OAuth 2.0 authorization is used the value is Bearer followed by a string representing the access token, see section 2.1 of RFC 6750 [8].

DataReportingConfiguration

M

1

201 Created

The creation of a Data Reporting Configuration resource is confirmed by the Data Collection AF.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of TS 29.500 [9] also apply.

apiRoot

string

See clause 5.2.

apiVersion

See clause 5.2.

sessionId

ResourceId

Identifier of the Data Reporting Provisioning Session resource at the Data Collection AF.

configurationId

ResourceId

Identifier of the Data Reporting Configuration resource at the Data Collection AF.

Authorization

string

M

1

For authentication of the Provisioning AF (see NOTE).

Origin

string

O

0..1

Indicates the origin of the requester.

NOTE: If OAuth 2.0 authorization is used, the value is Bearer followed by a string representing the access token, see section 2.1 RFC 6750 [8].

DataReportingConfiguration

M

1

200 OK

The requested Data Reporting Configuration resource is returned to the Provisioning AF by the Data Collection AF.

ProblemDetails

O

0..1

307 Temporary Redirect

Temporary redirection during a Data Reporting Configuration retrieval procedure. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance.

Applicable if the feature "ES3XX" (Extended Support of HTTP 307/308 redirection as defined in TS 29.502 [11]) is supported.

ProblemDetails

O

0..1

308 Permanent Redirect

Permanent redirection during a Data Reporting Session Configuration retrieval procedure. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance.

Applicable if the feature "ES3XX" is supported.

ProblemDetails

O

0..1

404 Not Found

This Data Reporting Provisioning Session resource does not exist (see NOTE 2).

NOTE 1: The mandatory HTTP error status codes for the GET method as listed in table 5.2.7.1-1 of TS 29.500 [9] also apply.

NOTE 2: Failure cases are described in clause 6.4.

Access-Control-Allow-Origin

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Access-Control-Allow-Methods

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: POST, PUT, DELETE.

Access-Control-Expose-Headers

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: Location.

Location

string

M

1

An alternative URL of the resource located in another Data Collection AF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

Access-Control-Allow-Origin

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Access-Control-Allow-Methods

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: POST, PUT, DELETE

Access-Control-Expose-Headers

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: Location

DataReportingConfiguration

M

1

Parameters to replace an existing Data Reporting Configuration resource.

DataReportingConfigurationPatch

M

1

Parameters to modify an existing Data Reporting Configuration resource.

Authorization

string

M

1

For authentication of the Provisioning AF (see NOTE).

Origin

string

O

0..1

Indicates the origin of the requester.

NOTE : If OAuth 2.0 authorization is used the value is Bearer followed by a string representing the access token, see section 2.1 RFC 6750 [8]

DataReportingConfiguration

M

1

200 OK

Confirmation of successful replacement or modification of a Data Reporting Configuration resource, along with a representation of the status of the update operation, carried in the response body, is returned by the Data Collection AF.

n/a

0

204 No Content

Confirmation of successful replacement or modification of a Data Reporting Configuration resource is returned by the Data Collection AF, without an associated response body.

ProblemDetails

O

0..1

307 Temporary Redirect

Temporary redirection, during a Data Reporting Configuration update operation. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance.

Applicable if the feature "ES3XX" (Extended Support of HTTP 307/308 redirection as defined in TS 29.502 [11]) is supported.

ProblemDetails

O

0..1

308 Permanent Redirect

Permanent redirection, during a Data Reporting Configuration update operation. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance.

Applicable if the feature "ES3XX" is supported.

ProblemDetails

O

0..1

404 Not Found

This Data Reporting Configuration resource does not exist (see NOTE 2).

NOTE 1: The mandatory HTTP error status codes for the PUT and PATCH methods listed in table 5.2.7.1-1 of TS 29.500 [9] also apply.

NOTE 2: Failure cases are described in clause 6.4.

Access-Control-Allow-Origin

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Access-Control-Allow-Methods

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: POST, PUT, DELETE.

Access-Control-Expose-Headers

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: Location.

Location

string

M

1

An alternative URL of the resource located in another Data Collection AF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

Access-Control-Allow-Origin

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Access-Control-Allow-Methods

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: POST, PUT, PATCH, DELETE

Access-Control-Expose-Headers

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: Location

Authorization

string

M

1

For authentication of the Provisioning AF (see NOTE).

Origin

string

O

0..1

Indicates the origin of the requester.)

NOTE: If OAuth 2.0 authorization is used the value is Bearer followed by a string representing the access token, see section 2.1 of RFC 6750 [8].

n/a

204 No Content

Success case: The Data Reporting Configuration resource matching the configurationId was destroyed at the Data Collection AF.

ProblemDetails

O

0..1

307 Temporary Redirect

Temporary redirection during Data Reporting Configuration destruction. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance.

Applicable if the feature "ES3XX" as defined in TS 29.502 [11] is supported.

ProblemDetails

O

0..1

308 Permanent Redirect

Permanent redirection during Data Reporting Configuration destruction. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance.

Applicable if the feature "ES3XX" is supported.

ProblemDetails

O

0..1

404 Not Found

The Data Reporting Configuration resource does not exist (see NOTE 2).

NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of TS 29.500 [9] also apply.

NOTE 2: Failure cases are described in clause 6.4.

Access-Control-Allow-Origin

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Access-Control-Allow-Methods

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: POST, PUT, DELETE.

Access-Control-Expose-Headers

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: Location.

Location

string

M

1

An alternative URL of the resource located in another Data Collection AF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

Access-Control-Allow-Origin

string

O

0..1

Part of CORS [10].Supplied if the request included the Origin header.

Access-Control-Allow-Methods

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: POST, PUT, PATCH, DELETE.

Access-Control-Expose-Headers

string

O

0..1

Part of CORS [10]. Supplied if the request included the Origin header.

Valid values: Location.

DataReportingProvisioningSession

6.3.2.1

A session provisioned in the Data Collection AF for the purpose of collecting, reporting and exposing UE data for a particular type of Event.

DataReportingConfiguration

6.3.2.2

The provisioned configuration for one type of data collection client within the scope of a Data Reporting Provisioning Session.

DataReportingConfigurationPatch

6.3.2.2A

Parameters to be modified in an existing provisioned configuration for one type of data collection client within the scope of a Data Reporting Provisioning Session.

AfEvent

Identifies a type of event.

TS 29.517 [5]

ApplicationId

Identifies the reporting application.

TS 29.571 [12]

DateTime

A point in time, expressed as an ISO 8601 [25] date and time.

DurationSec

A period of time, expressed in seconds.

Double

Float

Int32

Int64

Uint16

Uint32

Uint64

Uinteger

provisioningSessionId

string

1..1

C: R
R: RO
U: RO

A unique identifier for this Data Reporting Provisioning Session.

aspId

AspId

1..1

C: W
R: RO
U: RO

The identity of the Application Service Provider (as specified in clause 5.6.2.3 of TS 29.514 [26]) whose Provisioning AF is responsible for this Data Reporting Provisioning Session.

externalApplicationId

ApplicationID

1..1

C: RW
R: RO
U: RO

The external application identifier (see TS 29.571 [12]), nominated by the Provisioning AF, to which this Data Reporting Provisioning Session pertains, and which is present in data reports submitted to the Data Collection AF.

This property may also be used by the Event Consumer AF (located outside trusted domain) to subscribe to events in the Data Collection AF (located inside trusted domain).

internalApplicationId

ApplicationID

0..1

C: RW
R: RO
U: RO

The internal application identifier (see TS 29.571 [12]) to be used by event consumers inside the trusted domain (including the NWDAF, the Event Consumer AF and the NEF) when subscribing to events in the Data Collection AF.

This shall be provided by a Provisioning AF deployed inside the trusted domain when it creates a Data Reporting Provisioning Session. When the Provisioning AF is deployed outside the trusted domain, the NEF shall supply this property on behalf of the Provisioning AF by translating the externalApplicationId value supplied above into the corresponding internal application identifier here.

Always present when this Data Reporting Provisioning Session is returned to an entity inside the trusted domain. Never present when the Data Reporting Provisioning Session is returned to an entity outside the trusted domain.

eventId

AfEvent

1..1

C: RO
R: RO
U: RO

The type of event to which this Data Reporting Provisioning Session pertains. (See clause 5.6.3.3 of TS 29.517 [5].)

dataReportingConfigurationIds

Array(ResourceId)

0..1

C: —
R: RO
U: RO

A set of identifiers for Data Reporting Configurations currently associated with this Data Reporting Provisioning Session.

dataReportingConfigurationId

ResourceId

1..1

C: R

U: –

A unique identifier for this Data Reporting Configuration.

dataCollectionClientType

DataCollection‌Client‌Type

1..1

C: RW

U: –

The type of data collection client to which this Data Reporting Configuration pertains (see clause 5.4.3.1).

authorizationURL

Url

0..1

C: RW

U: RW

A URL that may be used to authorize the consumer entity prior to a data reporting subscription.

dataAccessProfiles

Array(Data‌Access‌Profile)

1..1

C: RW

U: RW

One or more Data Access Profile definitions, each describing a set of data processing instructions, applied by the Data Collection AF when exposing events.

authorizationURL

Url

0..1

C: RW

U: RW

A URL that may be used to authorize the consumer entity prior to a data reporting subscription.

dataAccessProfiles

Array(Data‌Access‌Profile)

0..1

C: RW

U: RW

One or more Data Access Profile definitions, each describing a set of data processing instructions, applied by the Data Collection AF when exposing events.

dataAccessProfileId

string

1..1

C: RW

U: RW

A unique identifier for this Data Access Profile.

targetEventConsumer‌Types

Array(Event‌Consumer‌Type)

1..1

C:RW

U:RW

The set of Event consumer types (see clause 6.3.3.1) to which this Data Access Profile is targeted.

If the set is empty, this Data Access Profile applies to all types of Event consumer.

parameters

Array(String)

1..1

C:RW

U:RW

The set of UE data parameters to be collected by the data collection client, and for which the restrictions specified by this Data Access Profile apply.

The parameters are uniquely identified by a controlled vocabulary specific to the Event ID indicated by the parent Data Reporting Provisioning Session.

If the set is empty, the restrictions apply to all parameters for the Event ID of the parent Data Reporting Provisioning Session.

timeAccessRestrictions

Object

0..1

C:RW

U:RW

Configuration for access restrictions along the time dimension.

duration

DurationSec

1..1

C:RW

U:RW

The period of time over which access is to be aggregated.

aggregationFunctions

Array(Data‌Aggregation‌Function‌Type)

1..1

C:RW

U:RW

An ordered, non-empty list of aggregation functions (see clause 6.3.3.2) applied to the event data prior to exposure to event consumers.

userAccessRestrictions

Object

0..1

C:RW

U:RW

Configuration for access restrictions along the user dimension.

groupIds

Array(GroupId)

1..1

C:RW

U:RW

Identifiers of the UE groups over which access is to be aggregated.

userIds

Array(Gpsi) or Array(Supi)

1..1

C:RW

U:RW

Identifiers of the UEs comprising a group over which access is to be aggregated.

aggregationFunctions

Array(Data‌Aggregation‌Function‌Type)

1..1

C:RW

U:RW

An ordered, non-empty list of aggregation functions (see clause 6.3.3.2) applied to the event data prior to exposure to event consumers.

locationAccessRestrictions

Object

0..1

C:RW

U:RW

Configuration for access restrictions along the location dimension

locationAreas

Array(Location‌Area‌5G)

1..1

C:RW

U:RW

Identifiers of geographical areas over which access is to be aggregated. Event data is grouped by the location of the UE during the data collection.

aggregationFunctions

Array(Data‌Aggregation‌Function‌Type)

1..1

C:RW

U:RW

An ordered, non-empty list of aggregation functions (see clause 6.3.3.2) applied to the event data prior to exposure to event consumers.

NOTE: Data types DurationSec, GroupId, Gpsi, Supi and LocationArea5G are defined in TS 29.571 [13].

NWDAF

The Network Data Analytics Function is the Event Consumer.

EVENT_CONSUMER_AF

The Event Consumer AF is the Event Consumer.

NEF

The Network Exposure Function is the Event Consumer.

NULL

No aggregation is applied: all values of the UE data parameter(s) are exposed to event consumers.

COUNT

The number of observed events over the indicated time period or the indicated set of users or the indicated set of locations is exposed to event consumers.

MEAN

The mean average of the values of the UE data parameter(s) over the indicated time period or the indicated set of users or the indicated set of locations is exposed to event consumers.

MAXIMUM

The maximum observed value of the UE data parameter(s) over the indicated time period or the indicated set of users or the indicated set of locations is exposed to event consumers.

MINIMUM

The minimum observed value of the UE data parameter(s) over the indicated time period or the indicated set of users or the indicated set of locations is exposed to event consumers.

SUM

The sum of the values of the UE data parameter(s) over the indicated time period or the indicated set of users or the indicated set of locations is exposed to event consumers.