OpenAPI
OpenAPI Version: 3.0.0
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
OpenAPI Version: 3.0.0
Title: CAPIF_Auditing_API
Description: This API enables the API management function to communicate with the CAPIF core function to retrieve the log information related to service API invocations.
Version: "1.0.0"
Description: 3GPP TS 29.222 V15.2.0 Common API Framework for 3GPP Northbound APIs
URL: http://www.3gpp.org/ftp/Specs/archive/29_series/29.222/
URL: '{apiRoot}/logs/v1'
Variables:
API Root:
Default: https://example.com
Description: apiRoot as defined in subclause 7.5 of 3GPP TS 29.222.
get:
Description: Query and retrieve service API invocation logs stored on the CAPIF core function.
Parameters:
- name: aef-id
In: query
Description: String identifying the API exposing function.
Schema:
Type: string
- name: api-invoker-id
In: query
Description: String identifying the API invoker which invoked the service API.
Schema:
Type: string
- name: time-range-start
In: query
Description: Start time of the invocation time range.
Schema:
Reference: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
- name: time-range-end
In: query
Description: End time of the invocation time range.
Schema:
Reference: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
- name: api-id
In: query
Description: String identifying the API invoked.
Schema:
Type: string
- name: api-name
In: query
Description: API name, it is set as {apiName} part of the URI structure as defined in subclause 4.4 of 3GPP TS 29.501.
Schema:
Type: string
- name: api-version
In: query
Description: Version of the API which was invoked.
Schema:
Type: string
- name: protocol
In: query
Description: Protocol invoked.
Schema:
Reference: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Protocol'
- name: operation
In: query
Description: Operation that was invoked on the API.
Schema:
Reference: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Operation'
- name: result
In: query
Description: Result or output of the invocation.
Schema:
Type: string
- name: resource-name
In: query
Description: Name of the specific resource invoked.
Schema:
Type: string
- name: src-interface
In: query
Description: Interface description of the API invoker.
Content:
Application/JSON:
Schema:
Reference: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/InterfaceDescription'
- name: dest-interface
In: query
Description: Interface description of the API invoked.
Content:
Application/JSON:
Schema:
Reference: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/InterfaceDescription'
- name: supported-features
In: query
Description: To filter irrelevant responses related to unsupported features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200' Result of the query operation along with fetched service API invocation log data.
Content:
Application/JSON:
Schema:
Reference: 'TS29222_CAPIF_Logging_API_Invocation_API.yaml#/components/schemas/InvocationLog'
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'
'414': Reference 'TS29122_CommonData.yaml#/components/responses/414'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'