CAPIF_Discover_Service_API

Default

allServiceAPIsGet

Discover published service APIs and retrieve a collection of APIs according to certain filter criteria.


/allServiceAPIs

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/service-apis/v1/allServiceAPIs?api-invoker-id=apiInvokerId_example&api-name=apiName_example&api-version=apiVersion_example&comm-type=&protocol=&aef-id=aefId_example&data-format=&api-cat=apiCat_example&preferred-aef-loc=&supported-features=supportedFeatures_example&api-supported-features=apiSupportedFeatures_example"
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 apiInvokerId = apiInvokerId_example; // String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.

        String apiName = apiName_example; // 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.

        String apiVersion = apiVersion_example; // String | API major version the URI (e.g. v1).
        CommunicationType commType = ; // CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE).
        Protocol protocol = ; // Protocol | Protocol used by the API.
        String aefId = aefId_example; // String | AEF identifer.
        DataFormat dataFormat = ; // DataFormat | Data formats used by the API (e.g. serialization protocol JSON used).
        String apiCat = apiCat_example; // String | The service API category to which the service API belongs to.
        AefLocation preferredAefLoc = ; // AefLocation | The preferred AEF location.
        String supportedFeatures = supportedFeatures_example; // String | Features supported by the NF consumer for the CAPIF Discover Service API.
        String apiSupportedFeatures = apiSupportedFeatures_example; // String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.


        try {
            DiscoveredAPIs result = apiInstance.allServiceAPIsGet(apiInvokerId, apiName, apiVersion, commType, protocol, aefId, dataFormat, apiCat, preferredAefLoc, supportedFeatures, apiSupportedFeatures);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#allServiceAPIsGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String apiInvokerId = new String(); // String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.

final String apiName = new String(); // 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.

final String apiVersion = new String(); // String | API major version the URI (e.g. v1).
final CommunicationType commType = new CommunicationType(); // CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE).
final Protocol protocol = new Protocol(); // Protocol | Protocol used by the API.
final String aefId = new String(); // String | AEF identifer.
final DataFormat dataFormat = new DataFormat(); // DataFormat | Data formats used by the API (e.g. serialization protocol JSON used).
final String apiCat = new String(); // String | The service API category to which the service API belongs to.
final AefLocation preferredAefLoc = new AefLocation(); // AefLocation | The preferred AEF location.
final String supportedFeatures = new String(); // String | Features supported by the NF consumer for the CAPIF Discover Service API.
final String apiSupportedFeatures = new String(); // String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.


try {
    final result = await api_instance.allServiceAPIsGet(apiInvokerId, apiName, apiVersion, commType, protocol, aefId, dataFormat, apiCat, preferredAefLoc, supportedFeatures, apiSupportedFeatures);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->allServiceAPIsGet: $e\n');
}

import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String apiInvokerId = apiInvokerId_example; // String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.

        String apiName = apiName_example; // 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.

        String apiVersion = apiVersion_example; // String | API major version the URI (e.g. v1).
        CommunicationType commType = ; // CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE).
        Protocol protocol = ; // Protocol | Protocol used by the API.
        String aefId = aefId_example; // String | AEF identifer.
        DataFormat dataFormat = ; // DataFormat | Data formats used by the API (e.g. serialization protocol JSON used).
        String apiCat = apiCat_example; // String | The service API category to which the service API belongs to.
        AefLocation preferredAefLoc = ; // AefLocation | The preferred AEF location.
        String supportedFeatures = supportedFeatures_example; // String | Features supported by the NF consumer for the CAPIF Discover Service API.
        String apiSupportedFeatures = apiSupportedFeatures_example; // String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.


        try {
            DiscoveredAPIs result = apiInstance.allServiceAPIsGet(apiInvokerId, apiName, apiVersion, commType, protocol, aefId, dataFormat, apiCat, preferredAefLoc, supportedFeatures, apiSupportedFeatures);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#allServiceAPIsGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *apiInvokerId = apiInvokerId_example; // String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
 (default to null)
String *apiName = apiName_example; // API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.
 (optional) (default to null)
String *apiVersion = apiVersion_example; // API major version the URI (e.g. v1). (optional) (default to null)
CommunicationType *commType = ; // Communication type used by the API (e.g. REQUEST_RESPONSE). (optional) (default to null)
Protocol *protocol = ; // Protocol used by the API. (optional) (default to null)
String *aefId = aefId_example; // AEF identifer. (optional) (default to null)
DataFormat *dataFormat = ; // Data formats used by the API (e.g. serialization protocol JSON used). (optional) (default to null)
String *apiCat = apiCat_example; // The service API category to which the service API belongs to. (optional) (default to null)
AefLocation *preferredAefLoc = ; // The preferred AEF location. (optional) (default to null)
String *supportedFeatures = supportedFeatures_example; // Features supported by the NF consumer for the CAPIF Discover Service API. (optional) (default to null)
String *apiSupportedFeatures = apiSupportedFeatures_example; // Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.
 (optional) (default to null)

[apiInstance allServiceAPIsGetWith:apiInvokerId
    apiName:apiName
    apiVersion:apiVersion
    commType:commType
    protocol:protocol
    aefId:aefId
    dataFormat:dataFormat
    apiCat:apiCat
    preferredAefLoc:preferredAefLoc
    supportedFeatures:supportedFeatures
    apiSupportedFeatures:apiSupportedFeatures
              completionHandler: ^(DiscoveredAPIs output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CapifDiscoverServiceApi = require('capif_discover_service_api');

// Create an instance of the API class
var api = new CapifDiscoverServiceApi.DefaultApi()
var apiInvokerId = apiInvokerId_example; // {String} String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.

var opts = {
  'apiName': apiName_example, // {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.

  'apiVersion': apiVersion_example, // {String} API major version the URI (e.g. v1).
  'commType': , // {CommunicationType} Communication type used by the API (e.g. REQUEST_RESPONSE).
  'protocol': , // {Protocol} Protocol used by the API.
  'aefId': aefId_example, // {String} AEF identifer.
  'dataFormat': , // {DataFormat} Data formats used by the API (e.g. serialization protocol JSON used).
  'apiCat': apiCat_example, // {String} The service API category to which the service API belongs to.
  'preferredAefLoc': , // {AefLocation} The preferred AEF location.
  'supportedFeatures': supportedFeatures_example, // {String} Features supported by the NF consumer for the CAPIF Discover Service API.
  'apiSupportedFeatures': apiSupportedFeatures_example // {String} Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.

};

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

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

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var apiInvokerId = apiInvokerId_example;  // String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
 (default to null)
            var apiName = apiName_example;  // 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.
 (optional)  (default to null)
            var apiVersion = apiVersion_example;  // String | API major version the URI (e.g. v1). (optional)  (default to null)
            var commType = new CommunicationType(); // CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE). (optional)  (default to null)
            var protocol = new Protocol(); // Protocol | Protocol used by the API. (optional)  (default to null)
            var aefId = aefId_example;  // String | AEF identifer. (optional)  (default to null)
            var dataFormat = new DataFormat(); // DataFormat | Data formats used by the API (e.g. serialization protocol JSON used). (optional)  (default to null)
            var apiCat = apiCat_example;  // String | The service API category to which the service API belongs to. (optional)  (default to null)
            var preferredAefLoc = new AefLocation(); // AefLocation | The preferred AEF location. (optional)  (default to null)
            var supportedFeatures = supportedFeatures_example;  // String | Features supported by the NF consumer for the CAPIF Discover Service API. (optional)  (default to null)
            var apiSupportedFeatures = apiSupportedFeatures_example;  // String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.
 (optional)  (default to null)

            try {
                DiscoveredAPIs result = apiInstance.allServiceAPIsGet(apiInvokerId, apiName, apiVersion, commType, protocol, aefId, dataFormat, apiCat, preferredAefLoc, supportedFeatures, apiSupportedFeatures);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.allServiceAPIsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$apiInvokerId = apiInvokerId_example; // String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.

$apiName = apiName_example; // 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.

$apiVersion = apiVersion_example; // String | API major version the URI (e.g. v1).
$commType = ; // CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE).
$protocol = ; // Protocol | Protocol used by the API.
$aefId = aefId_example; // String | AEF identifer.
$dataFormat = ; // DataFormat | Data formats used by the API (e.g. serialization protocol JSON used).
$apiCat = apiCat_example; // String | The service API category to which the service API belongs to.
$preferredAefLoc = ; // AefLocation | The preferred AEF location.
$supportedFeatures = supportedFeatures_example; // String | Features supported by the NF consumer for the CAPIF Discover Service API.
$apiSupportedFeatures = apiSupportedFeatures_example; // String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.


try {
    $result = $api_instance->allServiceAPIsGet($apiInvokerId, $apiName, $apiVersion, $commType, $protocol, $aefId, $dataFormat, $apiCat, $preferredAefLoc, $supportedFeatures, $apiSupportedFeatures);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->allServiceAPIsGet: ', $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 $apiInvokerId = apiInvokerId_example; # String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.

my $apiName = apiName_example; # 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.

my $apiVersion = apiVersion_example; # String | API major version the URI (e.g. v1).
my $commType = ; # CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE).
my $protocol = ; # Protocol | Protocol used by the API.
my $aefId = aefId_example; # String | AEF identifer.
my $dataFormat = ; # DataFormat | Data formats used by the API (e.g. serialization protocol JSON used).
my $apiCat = apiCat_example; # String | The service API category to which the service API belongs to.
my $preferredAefLoc = ; # AefLocation | The preferred AEF location.
my $supportedFeatures = supportedFeatures_example; # String | Features supported by the NF consumer for the CAPIF Discover Service API.
my $apiSupportedFeatures = apiSupportedFeatures_example; # String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.


eval {
    my $result = $api_instance->allServiceAPIsGet(apiInvokerId => $apiInvokerId, apiName => $apiName, apiVersion => $apiVersion, commType => $commType, protocol => $protocol, aefId => $aefId, dataFormat => $dataFormat, apiCat => $apiCat, preferredAefLoc => $preferredAefLoc, supportedFeatures => $supportedFeatures, apiSupportedFeatures => $apiSupportedFeatures);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->allServiceAPIsGet: $@\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()
apiInvokerId = apiInvokerId_example # String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
 (default to null)
apiName = apiName_example # 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.
 (optional) (default to null)
apiVersion = apiVersion_example # String | API major version the URI (e.g. v1). (optional) (default to null)
commType =  # CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE). (optional) (default to null)
protocol =  # Protocol | Protocol used by the API. (optional) (default to null)
aefId = aefId_example # String | AEF identifer. (optional) (default to null)
dataFormat =  # DataFormat | Data formats used by the API (e.g. serialization protocol JSON used). (optional) (default to null)
apiCat = apiCat_example # String | The service API category to which the service API belongs to. (optional) (default to null)
preferredAefLoc =  # AefLocation | The preferred AEF location. (optional) (default to null)
supportedFeatures = supportedFeatures_example # String | Features supported by the NF consumer for the CAPIF Discover Service API. (optional) (default to null)
apiSupportedFeatures = apiSupportedFeatures_example # String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.
 (optional) (default to null)

try:
    api_response = api_instance.all_service_apis_get(apiInvokerId, apiName=apiName, apiVersion=apiVersion, commType=commType, protocol=protocol, aefId=aefId, dataFormat=dataFormat, apiCat=apiCat, preferredAefLoc=preferredAefLoc, supportedFeatures=supportedFeatures, apiSupportedFeatures=apiSupportedFeatures)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->allServiceAPIsGet: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let apiInvokerId = apiInvokerId_example; // String
    let apiName = apiName_example; // String
    let apiVersion = apiVersion_example; // String
    let commType = ; // CommunicationType
    let protocol = ; // Protocol
    let aefId = aefId_example; // String
    let dataFormat = ; // DataFormat
    let apiCat = apiCat_example; // String
    let preferredAefLoc = ; // AefLocation
    let supportedFeatures = supportedFeatures_example; // String
    let apiSupportedFeatures = apiSupportedFeatures_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.allServiceAPIsGet(apiInvokerId, apiName, apiVersion, commType, protocol, aefId, dataFormat, apiCat, preferredAefLoc, supportedFeatures, apiSupportedFeatures, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
api-invoker-id*
String
String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
Required
api-name
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.
api-version
String
API major version the URI (e.g. v1).
comm-type
CommunicationType
Communication type used by the API (e.g. REQUEST_RESPONSE).
protocol
Protocol
Protocol used by the API.
aef-id
String
AEF identifer.
data-format
DataFormat
Data formats used by the API (e.g. serialization protocol JSON used).
api-cat
String
The service API category to which the service API belongs to.
preferred-aef-loc
AefLocation
The preferred AEF location.
supported-features
String
Features supported by the NF consumer for the CAPIF Discover Service API.
api-supported-features
String
Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.

Responses

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

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