3GPP Application AM Contexts API

openapi: 3.2.0
info:
  title: 3gpp-am-policyauthorization Application AM Contexts API
  version: 1.2.0
  description: "API for AM policy authorization.  \n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-am-policyauthorization/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
tags:
- name: Application AM Contexts
paths:
  /{afId}/app-am-contexts:
    post:
      summary: Creates a new Individual application AM Context resource
      operationId: PostAppAmContexts
      tags:
      - Application AM Contexts
      parameters:
      - name: afId
        in: path
        description: Identifier of the AF
        required: true
        schema:
          type: string
      requestBody:
        description: new resource creation
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppAmContextExpData'
      responses:
        '201':
          description: Created (Successful creation)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppAmContextExpRespData'
          headers:
            Location:
              description: Contains the URI of the newly created resource.
              required: true
              schema:
                type: string
        '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
        '411':
          $ref: TS29122_CommonData.yaml#/components/responses/411
        '413':
          $ref: TS29122_CommonData.yaml#/components/responses/413
        '415':
          $ref: TS29122_CommonData.yaml#/components/responses/415
        '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
      callbacks:
        amEventNotification:
          '{$request.body#/evSubscs/eventNotifUri}':
            post:
              requestBody:
                description: Notification of an event occurrence.
                required: true
                content:
                  application/json:
                    schema:
                      $ref: TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/AmEventsNotification
              responses:
                '204':
                  description: The receipt of the notification is acknowledged
                '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
                '411':
                  $ref: TS29122_CommonData.yaml#/components/responses/411
                '413':
                  $ref: TS29122_CommonData.yaml#/components/responses/413
                '415':
                  $ref: TS29122_CommonData.yaml#/components/responses/415
                '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:
    SliceReplReqInfo:
      description: 'Represents the AF requested Network Slice Replacement requirements information.

        '
      type: object
      properties:
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        altSnssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        afServId:
          type: string
        altAfServId:
          type: string
      oneOf:
      - required:
        - snssai
        - altSnssai
      - required:
        - afServId
        - altAfServId
    AppAmContextExpRespData:
      description: 'It represents a response to a modification or creation request of an Individual Application AM resource. It may contain the notification of the already met events

        '
      anyOf:
      - $ref: TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/AppAmContextData
      - $ref: TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/AmEventsNotification
    GeographicalArea:
      description: Contains geographical area information (e.g.a civic address or shapes).
      type: object
      properties:
        civicAddress:
          $ref: TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress
        shapes:
          $ref: TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea
    SliceReplType:
      anyOf:
      - type: string
        enum:
        - INITIATE_AF_REQ_SLICE_REP
        - TERMINATE_AF_REQ_SLICE_REP
      - type: string
        description: 'This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

          '
      description: "Represents the type of the requested Network Slice Replacement.\nPossible values are:\n- INITIATE_AF_REQ_SLICE_REP: Indicates that the type of the requested Network Slice\n  Replacement is the initiation of an AF requested Network Slice Replacement.\n- TERMINATE_AF_REQ_SLICE_REP: Indicates that the type of the requested Network Slice\n  Replacement is the termination of a previously requested Network Slice Replacement from\n  the AF.\n"
    SliceReplReq:
      description: 'Represents the requested Network Slice Replacement requirements.

        '
      type: object
      properties:
        type:
          $ref: '#/components/schemas/SliceReplType'
        afSliceReplReq:
          $ref: '#/components/schemas/SliceReplReqInfo'
      required:
      - type
    AppAmContextExpData:
      description: Represents an Individual application AM context exposure resource.
      type: object
      properties:
        self:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        evSubscs:
          $ref: TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/AmEventsSubscData
        gpsi:
          $ref: TS29571_CommonData.yaml#/components/schemas/Gpsi
        highThruInd:
          type: boolean
        covReqs:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GeographicalArea'
          minItems: 1
        policyDuration:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSecRm
        sliceReplReq:
          $ref: '#/components/schemas/SliceReplReq'
        suppFeat:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
        requestTestNotification:
          type: boolean
          description: '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. Set to false or omitted otherwise.

            '
        websockNotifConfig:
          $ref: TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig
      required:
      - gpsi
      anyOf:
      - required:
        - highThruInd
      - required:
        - covReqs
      - required:
        - sliceReplReq
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: '3GPP TS 29.522 V19.5.0; 5G System; Network Exposure Function Northbound APIs.

    '
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/