3GPP All service API invocation logs (Collection) API

openapi: 3.2.0
info:
  title: CAPIF_Auditing_ All service API invocation logs (Collection) API
  description: "API for auditing.  \n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
  version: 1.4.0
servers:
- url: '{apiRoot}/logs/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222.
tags:
- name: All service API invocation logs (Collection)
paths:
  /apiInvocationLogs:
    get:
      description: Query and retrieve service API invocation logs stored on the CAPIF core function.
      operationId: GetAPIInvLogs
      tags:
      - All service API invocation logs (Collection)
      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:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTime
      - name: time-range-end
        in: query
        description: End time of the invocation time range.
        schema:
          $ref: 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: 'Contains the API name set to the value of the "<apiName>" placeholder of the API URI as defined in clause 5.2.4 of 3GPP TS 29.122 [14].

          '
        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:
          $ref: TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Protocol
      - name: operation
        in: query
        description: Operation that was invoked on the API.
        schema:
          $ref: 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:
              $ref: 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:
              $ref: TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/InterfaceDescription
      - name: supported-features
        in: query
        description: To filter irrelevant responses related to unsupported features
        schema:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
      - name: net-slice-info
        in: query
        description: 'Contains the identifier(s) of the network slice(s) within which the API shall be available.

          '
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: TS29435_NSCE_PolicyManagement.yaml#/components/schemas/NetSliceId
              minItems: 1
      responses:
        '200':
          description: 'Result of the query operation along with fetched service API invocation log data.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvocationLogsRetrieveRes'
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '406':
          $ref: TS29122_CommonData.yaml#/components/responses/406
        '414':
          $ref: TS29122_CommonData.yaml#/components/responses/414
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
components:
  schemas:
    InvocationLogs:
      type: object
      description: 'Represents several (more than one) invocation logs.

        '
      properties:
        multipleInvocationLogs:
          type: array
          items:
            $ref: TS29222_CAPIF_Logging_API_Invocation_API.yaml#/components/schemas/InvocationLog
          minItems: 1
        supportedFeatures:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
      required:
      - multipleInvocationLogs
    InvocationLogsRetrieveRes:
      description: 'Represents the result of an invocation logs retrieval request.

        '
      oneOf:
      - $ref: TS29222_CAPIF_Logging_API_Invocation_API.yaml#/components/schemas/InvocationLog
      - $ref: '#/components/schemas/InvocationLogs'
externalDocs:
  description: 3GPP TS 29.222 V19.4.0 Common API Framework for 3GPP Northbound APIs
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/