Discover Service AP Is
Discover published service APIs and retrieve a collection of APIs according to certain filter criteria.
String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
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 major version the URI (e.g. v1).
AEF identifer.
Data formats used by the API (e.g. serialization protocol JSON used).
The service API category to which the service API belongs to.
Features supported by the NF consumer for the CAPIF Discover Service API. Unavailable in R1.
Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present. Unavailable in R1.
If provided in a request, the value of the header is a string signalling the desired version of the API to be used in handling the request. If the provided version is not available, a 406 Not Acceptable response will be sent. If no Version header is provided, the latest available version will be used. This mechanism allows a user-agent to request a specfic version of the API when multiple versions are available.
The response body contains the result of the search over the list of registered APIs.
{
"serviceAPIDescriptions": [
{
"apiName": "string",
"apiId": "string",
"aefProfiles": [
{
"aefId": "string",
"versions": [
{
"apiVersion": "string",
"expiry": "string",
"resources": [
{
"resourceName": "string",
"uri": "string",
"custOpName": "string",
"operations": [
{}
],
"description": "string"
}
],
"custOperations": [
{
"custOpName": "string",
"operations": [
{}
],
"description": "string"
}
]
}
],
"securityMethods": [
{}
],
"domainName": "string",
"interfaceDescriptions": [
{
"ipv4Addr": "string",
"ipv6Addr": "string",
"fqdn": "string",
"port": 0,
"apiPrefix": "string",
"securityMethods": [
{}
]
}
]
}
],
"description": "string",
"supportedFeatures": "string",
"shareableInfo": {
"isShareable": false,
"capifProvDoms": [
"string"
]
},
"serviceAPICategory": "string",
"apiSuppFeats": "string",
"pubApiPath": {
"ccfIds": [
"string"
]
},
"ccfId": "string"
}
]
}Description of the service API as published by the service. Each service API description shall include AEF profiles matching the filter criteria.
Response Headers
The Version header in a response indicates the version of the API used to handle this request-response pair, in an API which has the potential to support multiple versions. Different versions may be requested using a Version header in a request.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.