8.8 CAPIF_Auditing_API
29.2223GPPCommon API Framework for 3GPP Northbound APIsRelease 18TS
8.8.1 API URI
The CAPIF_Auditing_API service shall use the CAPIF_Auditing_API.
The request URIs used in HTTP requests from the API management function towards the CAPIF core function shall have the Resource URI structure as defined in clause 7.5 with the following clarifications:
– The <apiName> shall be "logs".
– The <apiVersion> shall be "v1".
– The <apiSpecificSuffixes> shall be set as described in clause 8.8.2.
8.8.2 Resources
8.8.2.1 Overview
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 8.8.2.1-1 depicts the resource URIs structure for the CAPIF_Auditing_API.
Figure 8.8.2.1-1: Resource URI structure of the CAPIF_Auditing_API
Table 8.8.2.1-1 provides an overview of the resources and applicable HTTP methods.
Table 8.8.2.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
|
All service API invocation logs (Store) |
/apiInvocationLogs (NOTE) |
GET |
Query and retrieve service API invocation logs stored on the CAPIF core function |
|
NOTE: The path segment "apiInvocationLogs" does not follow the related naming convention defined in clause 7.5.1. The path segment is however kept as currently defined in this specification for backward compatibility considerations. |
|||
8.8.2.2 Resource: All service API invocation logs
8.8.2.2.1 Description
The All service API invocation logs resource represents a collection of service API invocation logs stored on the CAPIF core function. The resource is modelled as a Store resource archetype (see annex C.3 of 3GPP TS 29.501 [18])
8.8.2.2.2 Resource Definition
Resource URI: {apiRoot}/logs/<apiVersion>/apiInvocationLogs
This resource shall support the resource URI variables defined in table 8.8.2.2.2-1.
Table 8.8.2.2.2-1: Resource URI variables for this resource
|
Name |
Data Type |
Definition |
|
apiRoot |
string |
See clause 7.5 |
8.8.2.2.3 Resource Standard Methods
8.8.2.2.3.1 GET
This method shall support the URI query parameters specified in table 8.8.2.2.3.1-1.
Table 8.8.2.2.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
aef-id |
string |
O |
0..1 |
String identifying the API exposing function |
|
api-invoker-id |
string |
O |
0..1 |
String identifying the API invoker which invoked the service API |
|
time-range-start |
DateTime |
O |
0..1 |
Start time of the invocation time range |
|
time-range-end |
DateTime |
O |
0..1 |
End time of the invocation time range |
|
api-id |
string |
O |
0..1 |
String identifying the API invoked. |
|
api-name |
string |
O |
0..1 |
API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122 [14]. |
|
api-version |
string |
O |
0..1 |
Version of the API which was invoked |
|
protocol |
Protocol |
O |
0..1 |
Protocol invoked |
|
operation |
Operation |
O |
0..1 |
Operation that was invoked on the API |
|
result |
string |
O |
0..1 |
HTTP status code of the invocation |
|
resource-name |
string |
O |
0..1 |
Name of the specific resource invoked |
|
src-interface |
InterfaceDescription |
O |
0..1 |
Interface description of the API invoker. |
|
dest-interface |
InterfaceDescription |
O |
0..1 |
Interface description of the API invoked. |
|
supported-features |
SupportedFeatures |
O |
0..1 |
To filter irrelevant responses related to unsupported features. |
This method shall support the request data structures specified in table 8.8.2.2.3.1-2 and the response data structures and response codes specified in table 8.8.2.2.3.1-3.
Table 8.8.2.2.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 8.8.2.2.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
array(InvocationLog) |
O |
1..N |
200 OK |
Result of the query operation along with fetched service API invocation log data. |
|
n/a |
307 Temporary Redirect |
Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. |
||
|
n/a |
308 Permanent Redirect |
Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. |
||
|
ProblemDetails |
O |
0..1 |
414 URI Too Long |
Indicates that the server is refusing to service the request because the request-target is too long. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. |
||||
Table 8.8.2.2.3.1-4: 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 CAPIF core function. |
Table 8.8.2.2.3.1-5: 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 CAPIF core function. |
8.8.2.2.4 Resource Custom Operations
None.
8.8.3 Notifications
None.
8.8.4 Data Model
8.8.4.1 General
This clause specifies the application data model supported by the API. Data types listed in clause 7.2 also apply to this API.
Table 8.8.4.1-1 specifies the data types defined specifically for the CAPIF_Auditing_API service.
Table 8.8.4.1-1: CAPIF_Auditing_API specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
|
n/a |
Table 8.8.4.1-2 specifies data types re-used by the CAPIF_Auditing_API service:
Table 8.8.4.1-2: Re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
DateTime |
3GPP TS 29.122 [14] |
Used to indicate the start and end times. |
|
|
InvocationLog |
Clause 8.7.4.2.2 |
Used to represent logs of service API invocations stored on the CAPIF core function. |
|
|
Operation |
Clause 8.2.4.3.7 |
Used to indicate the HTTP operation. |
|
|
ProblemDetails |
3GPP TS 29.122 [14] |
Used to represent the problem details in an error message. |
|
|
SupportedFeatures |
3GPP TS 29.571 [19] |
Used to negotiate the applicability of optional features defined in table 8.8.6-1. |
8.8.4.2 Structured data types
None.
8.8.4.3 Simple data types and enumerations
None.
8.8.5 Error Handling
8.8.5.1 General
HTTP error handling shall be supported as specified in clause 7.7.
In addition, the requirements in the following clauses shall apply.
8.8.5.2 Protocol Errors
In this Release of the specification, there are no additional protocol errors applicable for the CAPIF_Auditing_API.
8.8.5.3 Application Errors
The application errors defined for the CAPIF_Auditing_API are listed in table 8.8.5.3-1.
Table 8.8.5.3-1: Application errors
|
Application Error |
HTTP status code |
Description |
Applicability |
8.8.6 Feature negotiation
General feature negotiation procedures are defined in clause 7.8.
Table 8.8.6-1: Supported Features
|
Feature number |
Feature Name |
Description |
|
n/a |