CAPIF_Publish_Service_API

Default

apfIdServiceApisGet

Retrieve all published APIs.


/{apfId}/service-apis

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/published-apis/v1/{apfId}/service-apis"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String apfId = apfId_example; // String | 

        try {
            array[ServiceAPIDescription] result = apiInstance.apfIdServiceApisGet(apfId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#apfIdServiceApisGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String apfId = new String(); // String | 

try {
    final result = await api_instance.apfIdServiceApisGet(apfId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->apfIdServiceApisGet: $e\n');
}

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String apfId = apfId_example; // String | 

        try {
            array[ServiceAPIDescription] result = apiInstance.apfIdServiceApisGet(apfId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#apfIdServiceApisGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *apfId = apfId_example; //  (default to null)

[apiInstance apfIdServiceApisGetWith:apfId
              completionHandler: ^(array[ServiceAPIDescription] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CapifPublishServiceApi = require('capif_publish_service_api');

// Create an instance of the API class
var api = new CapifPublishServiceApi.DefaultApi()
var apfId = apfId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apfIdServiceApisGet(apfId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class apfIdServiceApisGetExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var apfId = apfId_example;  // String |  (default to null)

            try {
                array[ServiceAPIDescription] result = apiInstance.apfIdServiceApisGet(apfId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.apfIdServiceApisGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$apfId = apfId_example; // String | 

try {
    $result = $api_instance->apfIdServiceApisGet($apfId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->apfIdServiceApisGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $apfId = apfId_example; # String | 

eval {
    my $result = $api_instance->apfIdServiceApisGet(apfId => $apfId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->apfIdServiceApisGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
apfId = apfId_example # String |  (default to null)

try:
    api_response = api_instance.apf_id_service_apis_get(apfId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->apfIdServiceApisGet: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let apfId = apfId_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.apfIdServiceApisGet(apfId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
apfId*
String
Required

Responses

Status: 200 - Definition of all service API(s) published by the API publishing function.

[
{

Represents the description of a service API as published by the APF.

Required: apiName
aefProfiles:
[ (1..∞)

AEF profile information, which includes the exposed API details (e.g. protocol).

undefined
]
apiId:
string

API identifier assigned by the CAPIF core function to the published service API. Shall not be present in the HTTP POST request from the API publishing function to the CAPIF core function. Shall be present in the HTTP POST response from the CAPIF core function to the API publishing function and in the HTTP GET response from the CAPIF core function to the API invoker (discovery API).

apiName:
string

API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.

apiSuppFeats:
undefined
ccfId:
string

CAPIF core function identifier.

description:
string

Text description of the API

pubApiPath:
undefined
serviceAPICategory:
string
shareableInfo:
undefined
supportedFeatures:
undefined
]

Status: 307 - Temporary Redirect

Name Type Format Description
Location String An alternative URI of the resource.

Status: 308 - Permanent Redirect

Name Type Format Description
Location String An alternative URI of the resource.

Status: 400 - Bad request

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 406 - Not Acceptable

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: default - Generic Error

apfIdServiceApisPost

Publish a new API.


/{apfId}/service-apis

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://example.com/published-apis/v1/{apfId}/service-apis" \
 -d '{
  "ccfId" : "ccfId",
  "serviceAPICategory" : "serviceAPICategory",
  "apiName" : "apiName",
  "shareableInfo" : {
    "capifProvDoms" : [ "capifProvDoms", "capifProvDoms" ],
    "isShareable" : true
  },
  "supportedFeatures" : "supportedFeatures",
  "description" : "description",
  "apiSuppFeats" : "apiSuppFeats",
  "aefProfiles" : [ {
    "protocol" : "HTTP_1_1",
    "securityMethods" : [ null, null ],
    "versions" : [ {
      "apiVersion" : "apiVersion",
      "custOperations" : [ {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      }, {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      } ],
      "resources" : [ {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      }, {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      } ],
      "expiry" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "apiVersion" : "apiVersion",
      "custOperations" : [ {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      }, {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      } ],
      "resources" : [ {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      }, {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      } ],
      "expiry" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "dataFormat" : "JSON",
    "domainName" : "domainName",
    "aefLocation" : {
      "dcId" : "dcId",
      "geoArea" : {
        "shape" : "POINT",
        "point" : {
          "lon" : 36.988422590534526,
          "lat" : -75.5850925717018
        }
      },
      "civicAddr" : {
        "POBOX" : "POBOX",
        "usageRules" : "usageRules",
        "country" : "country",
        "PRD" : "PRD",
        "PLC" : "PLC",
        "HNO" : "HNO",
        "PRM" : "PRM",
        "HNS" : "HNS",
        "FLR" : "FLR",
        "A1" : "A1",
        "A2" : "A2",
        "A3" : "A3",
        "A4" : "A4",
        "STS" : "STS",
        "A5" : "A5",
        "A6" : "A6",
        "RDSEC" : "RDSEC",
        "providedBy" : "providedBy",
        "LOC" : "LOC",
        "SEAT" : "SEAT",
        "UNIT" : "UNIT",
        "POD" : "POD",
        "RDBR" : "RDBR",
        "method" : "method",
        "LMK" : "LMK",
        "POM" : "POM",
        "ADDCODE" : "ADDCODE",
        "RD" : "RD",
        "PC" : "PC",
        "PCN" : "PCN",
        "BLD" : "BLD",
        "NAM" : "NAM",
        "ROOM" : "ROOM",
        "RDSUBBR" : "RDSUBBR"
      }
    },
    "aefId" : "aefId",
    "interfaceDescriptions" : [ {
      "ipv6Addr" : "ipv6Addr",
      "securityMethods" : [ "PSK", "PSK" ],
      "port" : 9606,
      "ipv4Addr" : "ipv4Addr"
    }, {
      "ipv6Addr" : "ipv6Addr",
      "securityMethods" : [ "PSK", "PSK" ],
      "port" : 9606,
      "ipv4Addr" : "ipv4Addr"
    } ]
  }, {
    "protocol" : "HTTP_1_1",
    "securityMethods" : [ null, null ],
    "versions" : [ {
      "apiVersion" : "apiVersion",
      "custOperations" : [ {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      }, {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      } ],
      "resources" : [ {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      }, {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      } ],
      "expiry" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "apiVersion" : "apiVersion",
      "custOperations" : [ {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      }, {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      } ],
      "resources" : [ {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      }, {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      } ],
      "expiry" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "dataFormat" : "JSON",
    "domainName" : "domainName",
    "aefLocation" : {
      "dcId" : "dcId",
      "geoArea" : {
        "shape" : "POINT",
        "point" : {
          "lon" : 36.988422590534526,
          "lat" : -75.5850925717018
        }
      },
      "civicAddr" : {
        "POBOX" : "POBOX",
        "usageRules" : "usageRules",
        "country" : "country",
        "PRD" : "PRD",
        "PLC" : "PLC",
        "HNO" : "HNO",
        "PRM" : "PRM",
        "HNS" : "HNS",
        "FLR" : "FLR",
        "A1" : "A1",
        "A2" : "A2",
        "A3" : "A3",
        "A4" : "A4",
        "STS" : "STS",
        "A5" : "A5",
        "A6" : "A6",
        "RDSEC" : "RDSEC",
        "providedBy" : "providedBy",
        "LOC" : "LOC",
        "SEAT" : "SEAT",
        "UNIT" : "UNIT",
        "POD" : "POD",
        "RDBR" : "RDBR",
        "method" : "method",
        "LMK" : "LMK",
        "POM" : "POM",
        "ADDCODE" : "ADDCODE",
        "RD" : "RD",
        "PC" : "PC",
        "PCN" : "PCN",
        "BLD" : "BLD",
        "NAM" : "NAM",
        "ROOM" : "ROOM",
        "RDSUBBR" : "RDSUBBR"
      }
    },
    "aefId" : "aefId",
    "interfaceDescriptions" : [ {
      "ipv6Addr" : "ipv6Addr",
      "securityMethods" : [ "PSK", "PSK" ],
      "port" : 9606,
      "ipv4Addr" : "ipv4Addr"
    }, {
      "ipv6Addr" : "ipv6Addr",
      "securityMethods" : [ "PSK", "PSK" ],
      "port" : 9606,
      "ipv4Addr" : "ipv4Addr"
    } ]
  } ],
  "apiId" : "apiId",
  "pubApiPath" : {
    "ccfIds" : [ "ccfIds", "ccfIds" ]
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String apfId = apfId_example; // String | 
        ServiceAPIDescription serviceAPIDescription = ; // ServiceAPIDescription | 

        try {
            ServiceAPIDescription result = apiInstance.apfIdServiceApisPost(apfId, serviceAPIDescription);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#apfIdServiceApisPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String apfId = new String(); // String | 
final ServiceAPIDescription serviceAPIDescription = new ServiceAPIDescription(); // ServiceAPIDescription | 

try {
    final result = await api_instance.apfIdServiceApisPost(apfId, serviceAPIDescription);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->apfIdServiceApisPost: $e\n');
}

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String apfId = apfId_example; // String | 
        ServiceAPIDescription serviceAPIDescription = ; // ServiceAPIDescription | 

        try {
            ServiceAPIDescription result = apiInstance.apfIdServiceApisPost(apfId, serviceAPIDescription);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#apfIdServiceApisPost");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *apfId = apfId_example; //  (default to null)
ServiceAPIDescription *serviceAPIDescription = ; // 

[apiInstance apfIdServiceApisPostWith:apfId
    serviceAPIDescription:serviceAPIDescription
              completionHandler: ^(ServiceAPIDescription output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CapifPublishServiceApi = require('capif_publish_service_api');

// Create an instance of the API class
var api = new CapifPublishServiceApi.DefaultApi()
var apfId = apfId_example; // {String} 
var serviceAPIDescription = ; // {ServiceAPIDescription} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apfIdServiceApisPost(apfId, serviceAPIDescription, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class apfIdServiceApisPostExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var apfId = apfId_example;  // String |  (default to null)
            var serviceAPIDescription = new ServiceAPIDescription(); // ServiceAPIDescription | 

            try {
                ServiceAPIDescription result = apiInstance.apfIdServiceApisPost(apfId, serviceAPIDescription);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.apfIdServiceApisPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$apfId = apfId_example; // String | 
$serviceAPIDescription = ; // ServiceAPIDescription | 

try {
    $result = $api_instance->apfIdServiceApisPost($apfId, $serviceAPIDescription);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->apfIdServiceApisPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $apfId = apfId_example; # String | 
my $serviceAPIDescription = WWW::OPenAPIClient::Object::ServiceAPIDescription->new(); # ServiceAPIDescription | 

eval {
    my $result = $api_instance->apfIdServiceApisPost(apfId => $apfId, serviceAPIDescription => $serviceAPIDescription);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->apfIdServiceApisPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
apfId = apfId_example # String |  (default to null)
serviceAPIDescription =  # ServiceAPIDescription | 

try:
    api_response = api_instance.apf_id_service_apis_post(apfId, serviceAPIDescription)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->apfIdServiceApisPost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let apfId = apfId_example; // String
    let serviceAPIDescription = ; // ServiceAPIDescription

    let mut context = DefaultApi::Context::default();
    let result = client.apfIdServiceApisPost(apfId, serviceAPIDescription, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
apfId*
String
Required
Body parameters
Name Description
serviceAPIDescription *

{

Represents the description of a service API as published by the APF.

Required: apiName
aefProfiles:
[ (1..∞)

AEF profile information, which includes the exposed API details (e.g. protocol).

undefined
]
apiId:
string

API identifier assigned by the CAPIF core function to the published service API. Shall not be present in the HTTP POST request from the API publishing function to the CAPIF core function. Shall be present in the HTTP POST response from the CAPIF core function to the API publishing function and in the HTTP GET response from the CAPIF core function to the API invoker (discovery API).

apiName:
string

API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.

apiSuppFeats:
undefined
ccfId:
string

CAPIF core function identifier.

description:
string

Text description of the API

pubApiPath:
undefined
serviceAPICategory:
string
shareableInfo:
undefined
supportedFeatures:
undefined

Responses

Status: 201 - Service API published successfully The URI of the created resource shall be returned in the "Location" HTTP header.

Name Type Format Description
Location String An alternative URI of the resource.

Status: 400 - Bad request

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 411 - Length Required

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 413 - Payload Too Large

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 415 - Unsupported Media Type

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: default - Generic Error

apfIdServiceApisServiceApiIdDelete

Unpublish a published service API.


/{apfId}/service-apis/{serviceApiId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/problem+json" \
 "https://example.com/published-apis/v1/{apfId}/service-apis/{serviceApiId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String serviceApiId = serviceApiId_example; // String | 
        String apfId = apfId_example; // String | 

        try {
            apiInstance.apfIdServiceApisServiceApiIdDelete(serviceApiId, apfId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#apfIdServiceApisServiceApiIdDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String serviceApiId = new String(); // String | 
final String apfId = new String(); // String | 

try {
    final result = await api_instance.apfIdServiceApisServiceApiIdDelete(serviceApiId, apfId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->apfIdServiceApisServiceApiIdDelete: $e\n');
}

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String serviceApiId = serviceApiId_example; // String | 
        String apfId = apfId_example; // String | 

        try {
            apiInstance.apfIdServiceApisServiceApiIdDelete(serviceApiId, apfId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#apfIdServiceApisServiceApiIdDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *serviceApiId = serviceApiId_example; //  (default to null)
String *apfId = apfId_example; //  (default to null)

[apiInstance apfIdServiceApisServiceApiIdDeleteWith:serviceApiId
    apfId:apfId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CapifPublishServiceApi = require('capif_publish_service_api');

// Create an instance of the API class
var api = new CapifPublishServiceApi.DefaultApi()
var serviceApiId = serviceApiId_example; // {String} 
var apfId = apfId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apfIdServiceApisServiceApiIdDelete(serviceApiId, apfId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class apfIdServiceApisServiceApiIdDeleteExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var serviceApiId = serviceApiId_example;  // String |  (default to null)
            var apfId = apfId_example;  // String |  (default to null)

            try {
                apiInstance.apfIdServiceApisServiceApiIdDelete(serviceApiId, apfId);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.apfIdServiceApisServiceApiIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$serviceApiId = serviceApiId_example; // String | 
$apfId = apfId_example; // String | 

try {
    $api_instance->apfIdServiceApisServiceApiIdDelete($serviceApiId, $apfId);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->apfIdServiceApisServiceApiIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $serviceApiId = serviceApiId_example; # String | 
my $apfId = apfId_example; # String | 

eval {
    $api_instance->apfIdServiceApisServiceApiIdDelete(serviceApiId => $serviceApiId, apfId => $apfId);
};
if ($@) {
    warn "Exception when calling DefaultApi->apfIdServiceApisServiceApiIdDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
serviceApiId = serviceApiId_example # String |  (default to null)
apfId = apfId_example # String |  (default to null)

try:
    api_instance.apf_id_service_apis_service_api_id_delete(serviceApiId, apfId)
except ApiException as e:
    print("Exception when calling DefaultApi->apfIdServiceApisServiceApiIdDelete: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let serviceApiId = serviceApiId_example; // String
    let apfId = apfId_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.apfIdServiceApisServiceApiIdDelete(serviceApiId, apfId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serviceApiId*
String
Required
apfId*
String
Required

Responses

Status: 204 - The individual published service API matching the serviceAPiId is deleted.

Status: 307 - Temporary Redirect

Name Type Format Description
Location String An alternative URI of the resource.

Status: 308 - Permanent Redirect

Name Type Format Description
Location String An alternative URI of the resource.

Status: 400 - Bad request

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: default - Generic Error

apfIdServiceApisServiceApiIdGet

Retrieve a published service API.


/{apfId}/service-apis/{serviceApiId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/published-apis/v1/{apfId}/service-apis/{serviceApiId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String serviceApiId = serviceApiId_example; // String | 
        String apfId = apfId_example; // String | 

        try {
            ServiceAPIDescription result = apiInstance.apfIdServiceApisServiceApiIdGet(serviceApiId, apfId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#apfIdServiceApisServiceApiIdGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String serviceApiId = new String(); // String | 
final String apfId = new String(); // String | 

try {
    final result = await api_instance.apfIdServiceApisServiceApiIdGet(serviceApiId, apfId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->apfIdServiceApisServiceApiIdGet: $e\n');
}

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String serviceApiId = serviceApiId_example; // String | 
        String apfId = apfId_example; // String | 

        try {
            ServiceAPIDescription result = apiInstance.apfIdServiceApisServiceApiIdGet(serviceApiId, apfId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#apfIdServiceApisServiceApiIdGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *serviceApiId = serviceApiId_example; //  (default to null)
String *apfId = apfId_example; //  (default to null)

[apiInstance apfIdServiceApisServiceApiIdGetWith:serviceApiId
    apfId:apfId
              completionHandler: ^(ServiceAPIDescription output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CapifPublishServiceApi = require('capif_publish_service_api');

// Create an instance of the API class
var api = new CapifPublishServiceApi.DefaultApi()
var serviceApiId = serviceApiId_example; // {String} 
var apfId = apfId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apfIdServiceApisServiceApiIdGet(serviceApiId, apfId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class apfIdServiceApisServiceApiIdGetExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var serviceApiId = serviceApiId_example;  // String |  (default to null)
            var apfId = apfId_example;  // String |  (default to null)

            try {
                ServiceAPIDescription result = apiInstance.apfIdServiceApisServiceApiIdGet(serviceApiId, apfId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.apfIdServiceApisServiceApiIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$serviceApiId = serviceApiId_example; // String | 
$apfId = apfId_example; // String | 

try {
    $result = $api_instance->apfIdServiceApisServiceApiIdGet($serviceApiId, $apfId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->apfIdServiceApisServiceApiIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $serviceApiId = serviceApiId_example; # String | 
my $apfId = apfId_example; # String | 

eval {
    my $result = $api_instance->apfIdServiceApisServiceApiIdGet(serviceApiId => $serviceApiId, apfId => $apfId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->apfIdServiceApisServiceApiIdGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
serviceApiId = serviceApiId_example # String |  (default to null)
apfId = apfId_example # String |  (default to null)

try:
    api_response = api_instance.apf_id_service_apis_service_api_id_get(serviceApiId, apfId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->apfIdServiceApisServiceApiIdGet: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let serviceApiId = serviceApiId_example; // String
    let apfId = apfId_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.apfIdServiceApisServiceApiIdGet(serviceApiId, apfId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serviceApiId*
String
Required
apfId*
String
Required

Responses

Status: 200 - Definition of individual service API published by the API publishing function.

{

Represents the description of a service API as published by the APF.

Required: apiName
aefProfiles:
[ (1..∞)

AEF profile information, which includes the exposed API details (e.g. protocol).

undefined
]
apiId:
string

API identifier assigned by the CAPIF core function to the published service API. Shall not be present in the HTTP POST request from the API publishing function to the CAPIF core function. Shall be present in the HTTP POST response from the CAPIF core function to the API publishing function and in the HTTP GET response from the CAPIF core function to the API invoker (discovery API).

apiName:
string

API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.

apiSuppFeats:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
ccfId:
string

CAPIF core function identifier.

description:
string

Text description of the API

pubApiPath:
{

Represents the published API path within the same CAPIF provider domain.

ccfIds:
[ (1..∞)

A list of CCF identifiers where the service API is already published.

string
]
serviceAPICategory:
string
shareableInfo:
{

Indicates whether the service API and/or the service API category can be shared to the list of CAPIF provider domains.

Required: isShareable
capifProvDoms:
[ (1..∞)

List of CAPIF provider domains to which the service API information to be shared.

string
]
isShareable:
boolean

Set to "true" indicates that the service API and/or the service API category can be shared to the list of CAPIF provider domain information. Otherwise set to "false".

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$

Status: 307 - Temporary Redirect

Name Type Format Description
Location String An alternative URI of the resource.

Status: 308 - Permanent Redirect

Name Type Format Description
Location String An alternative URI of the resource.

Status: 400 - Bad request

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 406 - Not Acceptable

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: default - Generic Error

apfIdServiceApisServiceApiIdPut

Update a published service API.


/{apfId}/service-apis/{serviceApiId}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://example.com/published-apis/v1/{apfId}/service-apis/{serviceApiId}" \
 -d '{
  "ccfId" : "ccfId",
  "serviceAPICategory" : "serviceAPICategory",
  "apiName" : "apiName",
  "shareableInfo" : {
    "capifProvDoms" : [ "capifProvDoms", "capifProvDoms" ],
    "isShareable" : true
  },
  "supportedFeatures" : "supportedFeatures",
  "description" : "description",
  "apiSuppFeats" : "apiSuppFeats",
  "aefProfiles" : [ {
    "protocol" : "HTTP_1_1",
    "securityMethods" : [ null, null ],
    "versions" : [ {
      "apiVersion" : "apiVersion",
      "custOperations" : [ {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      }, {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      } ],
      "resources" : [ {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      }, {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      } ],
      "expiry" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "apiVersion" : "apiVersion",
      "custOperations" : [ {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      }, {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      } ],
      "resources" : [ {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      }, {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      } ],
      "expiry" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "dataFormat" : "JSON",
    "domainName" : "domainName",
    "aefLocation" : {
      "dcId" : "dcId",
      "geoArea" : {
        "shape" : "POINT",
        "point" : {
          "lon" : 36.988422590534526,
          "lat" : -75.5850925717018
        }
      },
      "civicAddr" : {
        "POBOX" : "POBOX",
        "usageRules" : "usageRules",
        "country" : "country",
        "PRD" : "PRD",
        "PLC" : "PLC",
        "HNO" : "HNO",
        "PRM" : "PRM",
        "HNS" : "HNS",
        "FLR" : "FLR",
        "A1" : "A1",
        "A2" : "A2",
        "A3" : "A3",
        "A4" : "A4",
        "STS" : "STS",
        "A5" : "A5",
        "A6" : "A6",
        "RDSEC" : "RDSEC",
        "providedBy" : "providedBy",
        "LOC" : "LOC",
        "SEAT" : "SEAT",
        "UNIT" : "UNIT",
        "POD" : "POD",
        "RDBR" : "RDBR",
        "method" : "method",
        "LMK" : "LMK",
        "POM" : "POM",
        "ADDCODE" : "ADDCODE",
        "RD" : "RD",
        "PC" : "PC",
        "PCN" : "PCN",
        "BLD" : "BLD",
        "NAM" : "NAM",
        "ROOM" : "ROOM",
        "RDSUBBR" : "RDSUBBR"
      }
    },
    "aefId" : "aefId",
    "interfaceDescriptions" : [ {
      "ipv6Addr" : "ipv6Addr",
      "securityMethods" : [ "PSK", "PSK" ],
      "port" : 9606,
      "ipv4Addr" : "ipv4Addr"
    }, {
      "ipv6Addr" : "ipv6Addr",
      "securityMethods" : [ "PSK", "PSK" ],
      "port" : 9606,
      "ipv4Addr" : "ipv4Addr"
    } ]
  }, {
    "protocol" : "HTTP_1_1",
    "securityMethods" : [ null, null ],
    "versions" : [ {
      "apiVersion" : "apiVersion",
      "custOperations" : [ {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      }, {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      } ],
      "resources" : [ {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      }, {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      } ],
      "expiry" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "apiVersion" : "apiVersion",
      "custOperations" : [ {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      }, {
        "operations" : [ "GET", "GET" ],
        "commType" : "REQUEST_RESPONSE",
        "description" : "description",
        "custOpName" : "custOpName"
      } ],
      "resources" : [ {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      }, {
        "operations" : [ null, null ],
        "description" : "description",
        "custOpName" : "custOpName",
        "resourceName" : "resourceName",
        "uri" : "uri"
      } ],
      "expiry" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "dataFormat" : "JSON",
    "domainName" : "domainName",
    "aefLocation" : {
      "dcId" : "dcId",
      "geoArea" : {
        "shape" : "POINT",
        "point" : {
          "lon" : 36.988422590534526,
          "lat" : -75.5850925717018
        }
      },
      "civicAddr" : {
        "POBOX" : "POBOX",
        "usageRules" : "usageRules",
        "country" : "country",
        "PRD" : "PRD",
        "PLC" : "PLC",
        "HNO" : "HNO",
        "PRM" : "PRM",
        "HNS" : "HNS",
        "FLR" : "FLR",
        "A1" : "A1",
        "A2" : "A2",
        "A3" : "A3",
        "A4" : "A4",
        "STS" : "STS",
        "A5" : "A5",
        "A6" : "A6",
        "RDSEC" : "RDSEC",
        "providedBy" : "providedBy",
        "LOC" : "LOC",
        "SEAT" : "SEAT",
        "UNIT" : "UNIT",
        "POD" : "POD",
        "RDBR" : "RDBR",
        "method" : "method",
        "LMK" : "LMK",
        "POM" : "POM",
        "ADDCODE" : "ADDCODE",
        "RD" : "RD",
        "PC" : "PC",
        "PCN" : "PCN",
        "BLD" : "BLD",
        "NAM" : "NAM",
        "ROOM" : "ROOM",
        "RDSUBBR" : "RDSUBBR"
      }
    },
    "aefId" : "aefId",
    "interfaceDescriptions" : [ {
      "ipv6Addr" : "ipv6Addr",
      "securityMethods" : [ "PSK", "PSK" ],
      "port" : 9606,
      "ipv4Addr" : "ipv4Addr"
    }, {
      "ipv6Addr" : "ipv6Addr",
      "securityMethods" : [ "PSK", "PSK" ],
      "port" : 9606,
      "ipv4Addr" : "ipv4Addr"
    } ]
  } ],
  "apiId" : "apiId",
  "pubApiPath" : {
    "ccfIds" : [ "ccfIds", "ccfIds" ]
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String serviceApiId = serviceApiId_example; // String | 
        String apfId = apfId_example; // String | 
        ServiceAPIDescription serviceAPIDescription = ; // ServiceAPIDescription | 

        try {
            ServiceAPIDescription result = apiInstance.apfIdServiceApisServiceApiIdPut(serviceApiId, apfId, serviceAPIDescription);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#apfIdServiceApisServiceApiIdPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String serviceApiId = new String(); // String | 
final String apfId = new String(); // String | 
final ServiceAPIDescription serviceAPIDescription = new ServiceAPIDescription(); // ServiceAPIDescription | 

try {
    final result = await api_instance.apfIdServiceApisServiceApiIdPut(serviceApiId, apfId, serviceAPIDescription);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->apfIdServiceApisServiceApiIdPut: $e\n');
}

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String serviceApiId = serviceApiId_example; // String | 
        String apfId = apfId_example; // String | 
        ServiceAPIDescription serviceAPIDescription = ; // ServiceAPIDescription | 

        try {
            ServiceAPIDescription result = apiInstance.apfIdServiceApisServiceApiIdPut(serviceApiId, apfId, serviceAPIDescription);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#apfIdServiceApisServiceApiIdPut");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *serviceApiId = serviceApiId_example; //  (default to null)
String *apfId = apfId_example; //  (default to null)
ServiceAPIDescription *serviceAPIDescription = ; // 

[apiInstance apfIdServiceApisServiceApiIdPutWith:serviceApiId
    apfId:apfId
    serviceAPIDescription:serviceAPIDescription
              completionHandler: ^(ServiceAPIDescription output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CapifPublishServiceApi = require('capif_publish_service_api');

// Create an instance of the API class
var api = new CapifPublishServiceApi.DefaultApi()
var serviceApiId = serviceApiId_example; // {String} 
var apfId = apfId_example; // {String} 
var serviceAPIDescription = ; // {ServiceAPIDescription} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apfIdServiceApisServiceApiIdPut(serviceApiId, apfId, serviceAPIDescription, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class apfIdServiceApisServiceApiIdPutExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var serviceApiId = serviceApiId_example;  // String |  (default to null)
            var apfId = apfId_example;  // String |  (default to null)
            var serviceAPIDescription = new ServiceAPIDescription(); // ServiceAPIDescription | 

            try {
                ServiceAPIDescription result = apiInstance.apfIdServiceApisServiceApiIdPut(serviceApiId, apfId, serviceAPIDescription);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.apfIdServiceApisServiceApiIdPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$serviceApiId = serviceApiId_example; // String | 
$apfId = apfId_example; // String | 
$serviceAPIDescription = ; // ServiceAPIDescription | 

try {
    $result = $api_instance->apfIdServiceApisServiceApiIdPut($serviceApiId, $apfId, $serviceAPIDescription);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->apfIdServiceApisServiceApiIdPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $serviceApiId = serviceApiId_example; # String | 
my $apfId = apfId_example; # String | 
my $serviceAPIDescription = WWW::OPenAPIClient::Object::ServiceAPIDescription->new(); # ServiceAPIDescription | 

eval {
    my $result = $api_instance->apfIdServiceApisServiceApiIdPut(serviceApiId => $serviceApiId, apfId => $apfId, serviceAPIDescription => $serviceAPIDescription);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->apfIdServiceApisServiceApiIdPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
serviceApiId = serviceApiId_example # String |  (default to null)
apfId = apfId_example # String |  (default to null)
serviceAPIDescription =  # ServiceAPIDescription | 

try:
    api_response = api_instance.apf_id_service_apis_service_api_id_put(serviceApiId, apfId, serviceAPIDescription)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->apfIdServiceApisServiceApiIdPut: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let serviceApiId = serviceApiId_example; // String
    let apfId = apfId_example; // String
    let serviceAPIDescription = ; // ServiceAPIDescription

    let mut context = DefaultApi::Context::default();
    let result = client.apfIdServiceApisServiceApiIdPut(serviceApiId, apfId, serviceAPIDescription, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serviceApiId*
String
Required
apfId*
String
Required
Body parameters
Name Description
serviceAPIDescription *

{

Represents the description of a service API as published by the APF.

Required: apiName
aefProfiles:
[ (1..∞)

AEF profile information, which includes the exposed API details (e.g. protocol).

undefined
]
apiId:
string

API identifier assigned by the CAPIF core function to the published service API. Shall not be present in the HTTP POST request from the API publishing function to the CAPIF core function. Shall be present in the HTTP POST response from the CAPIF core function to the API publishing function and in the HTTP GET response from the CAPIF core function to the API invoker (discovery API).

apiName:
string

API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.

apiSuppFeats:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
ccfId:
string

CAPIF core function identifier.

description:
string

Text description of the API

pubApiPath:
{

Represents the published API path within the same CAPIF provider domain.

ccfIds:
serviceAPICategory:
string
shareableInfo:
{

Indicates whether the service API and/or the service API category can be shared to the list of CAPIF provider domains.

Required: isShareable
capifProvDoms:
isShareable:
supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$

Responses

Status: 200 - Definition of service API updated successfully.

{

Represents the description of a service API as published by the APF.

Required: apiName
aefProfiles:
[ (1..∞)

AEF profile information, which includes the exposed API details (e.g. protocol).

undefined
]
apiId:
string

API identifier assigned by the CAPIF core function to the published service API. Shall not be present in the HTTP POST request from the API publishing function to the CAPIF core function. Shall be present in the HTTP POST response from the CAPIF core function to the API publishing function and in the HTTP GET response from the CAPIF core function to the API invoker (discovery API).

apiName:
string

API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.

apiSuppFeats:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
ccfId:
string

CAPIF core function identifier.

description:
string

Text description of the API

pubApiPath:
{

Represents the published API path within the same CAPIF provider domain.

ccfIds:
[ (1..∞)

A list of CCF identifiers where the service API is already published.

string
]
serviceAPICategory:
string
shareableInfo:
{

Indicates whether the service API and/or the service API category can be shared to the list of CAPIF provider domains.

Required: isShareable
capifProvDoms:
[ (1..∞)

List of CAPIF provider domains to which the service API information to be shared.

string
]
isShareable:
boolean

Set to "true" indicates that the service API and/or the service API category can be shared to the list of CAPIF provider domain information. Otherwise set to "false".

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$

Status: 204 - No Content

Status: 307 - Temporary Redirect

Name Type Format Description
Location String An alternative URI of the resource.

Status: 308 - Permanent Redirect

Name Type Format Description
Location String An alternative URI of the resource.

Status: 400 - Bad request

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 411 - Length Required

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 413 - Payload Too Large

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 415 - Unsupported Media Type

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: default - Generic Error

IndividualAPFPublishedAPI

modifyIndAPFPubAPI

Modify an existing published service API.


/{apfId}/service-apis/{serviceApiId}

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/merge-patch+json" \
 "https://example.com/published-apis/v1/{apfId}/service-apis/{serviceApiId}" \
 -d 'Custom MIME type example not yet supported: application/merge-patch+json'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.IndividualAPFPublishedAPIApi;

import java.io.File;
import java.util.*;

public class IndividualAPFPublishedAPIApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        IndividualAPFPublishedAPIApi apiInstance = new IndividualAPFPublishedAPIApi();
        String serviceApiId = serviceApiId_example; // String | 
        String apfId = apfId_example; // String | 
        ServiceAPIDescriptionPatch serviceAPIDescriptionPatch = ; // ServiceAPIDescriptionPatch | 

        try {
            ServiceAPIDescription result = apiInstance.modifyIndAPFPubAPI(serviceApiId, apfId, serviceAPIDescriptionPatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndividualAPFPublishedAPIApi#modifyIndAPFPubAPI");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String serviceApiId = new String(); // String | 
final String apfId = new String(); // String | 
final ServiceAPIDescriptionPatch serviceAPIDescriptionPatch = new ServiceAPIDescriptionPatch(); // ServiceAPIDescriptionPatch | 

try {
    final result = await api_instance.modifyIndAPFPubAPI(serviceApiId, apfId, serviceAPIDescriptionPatch);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->modifyIndAPFPubAPI: $e\n');
}

import org.openapitools.client.api.IndividualAPFPublishedAPIApi;

public class IndividualAPFPublishedAPIApiExample {
    public static void main(String[] args) {
        IndividualAPFPublishedAPIApi apiInstance = new IndividualAPFPublishedAPIApi();
        String serviceApiId = serviceApiId_example; // String | 
        String apfId = apfId_example; // String | 
        ServiceAPIDescriptionPatch serviceAPIDescriptionPatch = ; // ServiceAPIDescriptionPatch | 

        try {
            ServiceAPIDescription result = apiInstance.modifyIndAPFPubAPI(serviceApiId, apfId, serviceAPIDescriptionPatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndividualAPFPublishedAPIApi#modifyIndAPFPubAPI");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
IndividualAPFPublishedAPIApi *apiInstance = [[IndividualAPFPublishedAPIApi alloc] init];
String *serviceApiId = serviceApiId_example; //  (default to null)
String *apfId = apfId_example; //  (default to null)
ServiceAPIDescriptionPatch *serviceAPIDescriptionPatch = ; // 

[apiInstance modifyIndAPFPubAPIWith:serviceApiId
    apfId:apfId
    serviceAPIDescriptionPatch:serviceAPIDescriptionPatch
              completionHandler: ^(ServiceAPIDescription output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CapifPublishServiceApi = require('capif_publish_service_api');

// Create an instance of the API class
var api = new CapifPublishServiceApi.IndividualAPFPublishedAPIApi()
var serviceApiId = serviceApiId_example; // {String} 
var apfId = apfId_example; // {String} 
var serviceAPIDescriptionPatch = ; // {ServiceAPIDescriptionPatch} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifyIndAPFPubAPI(serviceApiId, apfId, serviceAPIDescriptionPatch, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyIndAPFPubAPIExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new IndividualAPFPublishedAPIApi();
            var serviceApiId = serviceApiId_example;  // String |  (default to null)
            var apfId = apfId_example;  // String |  (default to null)
            var serviceAPIDescriptionPatch = new ServiceAPIDescriptionPatch(); // ServiceAPIDescriptionPatch | 

            try {
                ServiceAPIDescription result = apiInstance.modifyIndAPFPubAPI(serviceApiId, apfId, serviceAPIDescriptionPatch);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling IndividualAPFPublishedAPIApi.modifyIndAPFPubAPI: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IndividualAPFPublishedAPIApi();
$serviceApiId = serviceApiId_example; // String | 
$apfId = apfId_example; // String | 
$serviceAPIDescriptionPatch = ; // ServiceAPIDescriptionPatch | 

try {
    $result = $api_instance->modifyIndAPFPubAPI($serviceApiId, $apfId, $serviceAPIDescriptionPatch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IndividualAPFPublishedAPIApi->modifyIndAPFPubAPI: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::IndividualAPFPublishedAPIApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::IndividualAPFPublishedAPIApi->new();
my $serviceApiId = serviceApiId_example; # String | 
my $apfId = apfId_example; # String | 
my $serviceAPIDescriptionPatch = WWW::OPenAPIClient::Object::ServiceAPIDescriptionPatch->new(); # ServiceAPIDescriptionPatch | 

eval {
    my $result = $api_instance->modifyIndAPFPubAPI(serviceApiId => $serviceApiId, apfId => $apfId, serviceAPIDescriptionPatch => $serviceAPIDescriptionPatch);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IndividualAPFPublishedAPIApi->modifyIndAPFPubAPI: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.IndividualAPFPublishedAPIApi()
serviceApiId = serviceApiId_example # String |  (default to null)
apfId = apfId_example # String |  (default to null)
serviceAPIDescriptionPatch =  # ServiceAPIDescriptionPatch | 

try:
    api_response = api_instance.modify_ind_apf_pub_api(serviceApiId, apfId, serviceAPIDescriptionPatch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IndividualAPFPublishedAPIApi->modifyIndAPFPubAPI: %s\n" % e)
extern crate IndividualAPFPublishedAPIApi;

pub fn main() {
    let serviceApiId = serviceApiId_example; // String
    let apfId = apfId_example; // String
    let serviceAPIDescriptionPatch = ; // ServiceAPIDescriptionPatch

    let mut context = IndividualAPFPublishedAPIApi::Context::default();
    let result = client.modifyIndAPFPubAPI(serviceApiId, apfId, serviceAPIDescriptionPatch, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serviceApiId*
String
Required
apfId*
String
Required
Body parameters
Name Description
serviceAPIDescriptionPatch *

{

Represents the parameters to request the modification of an APF published API resource.

aefProfiles:
[ (1..∞)
undefined
]
apiSuppFeats:
undefined
ccfId:
string

CAPIF core function identifier.

description:
string

Text description of the API

pubApiPath:
undefined
serviceAPICategory:
string
shareableInfo:
undefined

Responses

Status: 200 - The definition of the service API is modified successfully and a representation of the updated service API is returned in the request body.

{

Represents the description of a service API as published by the APF.

Required: apiName
aefProfiles:
[ (1..∞)

AEF profile information, which includes the exposed API details (e.g. protocol).

undefined
]
apiId:
string

API identifier assigned by the CAPIF core function to the published service API. Shall not be present in the HTTP POST request from the API publishing function to the CAPIF core function. Shall be present in the HTTP POST response from the CAPIF core function to the API publishing function and in the HTTP GET response from the CAPIF core function to the API invoker (discovery API).

apiName:
string

API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.

apiSuppFeats:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
ccfId:
string

CAPIF core function identifier.

description:
string

Text description of the API

pubApiPath:
{

Represents the published API path within the same CAPIF provider domain.

ccfIds:
[ (1..∞)

A list of CCF identifiers where the service API is already published.

string
]
serviceAPICategory:
string
shareableInfo:
{

Indicates whether the service API and/or the service API category can be shared to the list of CAPIF provider domains.

Required: isShareable
capifProvDoms:
[ (1..∞)

List of CAPIF provider domains to which the service API information to be shared.

string
]
isShareable:
boolean

Set to "true" indicates that the service API and/or the service API category can be shared to the list of CAPIF provider domain information. Otherwise set to "false".

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$

Status: 204 - No Content. The definition of the service API is modified successfully.

Status: 307 - Temporary Redirect

Name Type Format Description
Location String An alternative URI of the resource.

Status: 308 - Permanent Redirect

Name Type Format Description
Location String An alternative URI of the resource.

Status: 400 - Bad request

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 411 - Length Required

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 413 - Payload Too Large

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 415 - Unsupported Media Type

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

{

Represents additional information and details on an error response.

cause:
string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:
string

A human-readable explanation specific to this occurrence of the problem.

instance:
string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:
[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined
]
status:
integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:
string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$
title:
string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:
string

string providing an URI formatted according to IETF RFC 3986.

Status: default - Generic Error