/nf-instances/{nfInstanceID}


  get: 
    Summary: Read the profile of a given NF Instance 
    Operation ID: GetNFInstance 
 
    Tags: 
      - NF Instance ID (Document) 
 
    Parameters: 
      - Name: nfInstanceID 
        In: path 
        Description: Unique ID of the NF Instance 
        Required/Optional: true 
        Schema: 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 
 
    Responses: 
      '200': 
        Description: Expected response to a valid request 
        Content: 
          Application/JSON: 
            Schema: 
              Reference: '#/components/schemas/NFProfile' 
      '400': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/400' 
      '403': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/403' 
      '404': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/404' 
      '411': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/411' 
      '413': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/413' 
      '415': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/415' 
      '500': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/500' 
      '501': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/501' 
      '503': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/503' 
      Default: 
        Reference: 'TS29571_CommonData.yaml#/components/responses/default' 
  put: 
    Summary: Register a new NF Instance 
    Operation ID: RegisterNFInstance 
 
    Tags: 
      - NF Instance ID (Document) 
 
    Parameters: 
      - Name: nfInstanceID 
        In: path 
        Required/Optional: true 
        Description: Unique ID of the NF Instance to register 
        Schema: 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 
    Request Body: 
      Content: 
        Application/JSON: 
          Schema: 
            Reference: '#/components/schemas/NFProfile' 
      Required/Optional: true 
 
    Responses: 
      '200': 
        Description: OK (Profile Replacement) 
        Content: 
          Application/JSON: 
            Schema: 
              Reference: '#/components/schemas/NFProfile' 
      '201': 
        Description: Expected response to a valid request 
        Content: 
          Application/JSON: 
            Schema: 
              Reference: '#/components/schemas/NFProfile' 
        Headers: 
          Location: 
            description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnrf-nfm/v1/nf-instances/{nfInstanceId}' 
            Required/Optional: true 
            Schema: 
              Type: string 
      '400': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/400' 
      '403': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/403' 
      '404': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/404' 
      '411': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/411' 
      '413': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/413' 
      '415': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/415' 
      '500': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/500' 
      '501': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/501' 
      '503': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/503' 
      Default: 
        Reference: 'TS29571_CommonData.yaml#/components/responses/default' 
  patch: 
    Summary: Update NF Instance profile 
    Operation ID: UpdateNFInstance 
 
    Tags: 
      - NF Instance ID (Document) 
 
    Parameters: 
      - Name: nfInstanceID 
        In: path 
        Required/Optional: true 
        Description: Unique ID of the NF Instance to update 
        Schema: 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 
    Request Body: 
      Content: 
        application/json-patch+json: 
          Schema: 
            Type: array 
            Items: 
              Reference: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' 
            Min Items: 1 
      Required/Optional: true 
 
    Responses: 
      '200': 
        Description: Expected response to a valid request 
        Content: 
          Application/JSON: 
            Schema: 
              Reference: '#/components/schemas/NFProfile' 
      '204': 
        Description: Expected response with empty body 
      '400': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/400' 
      '403': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/403' 
      '404': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/404' 
      '411': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/411' 
      '413': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/413' 
      '415': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/415' 
      '500': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/500' 
      '501': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/501' 
      '503': 
        Reference: 'TS29571_CommonData.yaml#/components/responses/503' 
      Default: 
        Reference: 'TS29571_CommonData.yaml#/components/responses/default' 
  delete: 
    Summary: Deregisters a given NF Instance 
    Operation ID: DeregisterNFInstance 
 
    Tags: 
      - NF Instance ID (Document) 
 
    Parameters: 
      - Name: nfInstanceID 
        In: path 
        Required/Optional: true 
        Description: Unique ID of the NF Instance to deregister 
        Schema: 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 
 
    Responses: 
      '204': 
        Description: Expected response to a successful deregistration