All published service APIs

(Store)

/allServiceAPIs

(NOTE)

GET

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

NOTE: The path segment "allServiceAPIs" does not follow the related naming convention defined in subclause 7.5.1. The path segment is however kept as currently defined in this specification for backward compatibility considerations.

apiRoot

string

See clause 7.5

api-invoker-id

string

M

1

It represents the identifier (assigned by the CCF) ofthe API invoker that is sending the request. It may also represent the identifier of the CCF that is sending the request if the request is sent over the CAPIF-6/6e reference point. (NOTE)

api-name

string

O

0..1

Contains the API name as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122 [14].

api-version

string

O

0..1

Contains the API major version conveyed in the URI (e.g. v1).

comm-type

CommunicationType

O

0..1

Communication type used by the API (e.g. REQUEST_RESPONSE).

protocol

Protocol

O

0..1

Protocol used by the API.

aef-id

string

O

0..1

AEF identifier.

data-format

DataFormat

O

0..1

Data format used by the API (e.g. serialization protocol JSON).

api-cat

string

O

0..1

The service API category to which the service API belongs.

preferred-aef-loc

AefLocation

O

0..1

The preferred AEF location. If this parameter is present, the CCF shall try to discover a matched AEF location the service API supports. This parameter is ignored by the CCF if there is no matching record found.

supported-features

SupportedFeatures

O

0..1

To filter irrelevant responses related to unsupported features.

api-supported-features

SupportedFeatures

C

0..1

Features supported by the discovered service API indicated by api-name parameter. This may only be present if the api-name query parameter is present.

ApiSupportedFeatureQuery

NOTE: This parameter is not part of API filter criteria so that it is not used in matching APIs published in the CCF.

n/a

DiscoveredAPIs

M

1

200 OK

The response body contains the result of the search over the list of registered APIs.

n/a

307 Temporary Redirect

Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14].

n/a

308 Permanent Redirect

Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14].

ProblemDetails

O

0..1

414 URI Too Long

Indicates that the server refuses to process the request because the request-target is too long.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative CAPIF core function.

Location

string

M

1

An alternative URI of the resource located in an alternative CAPIF core function.

DiscoveredAPIs

Clause 8.1.4.2.2

Represents a list of APIs currently registered in the CAPIF core function

and satisfying a number of filter criteria provided by the API consumer.

AefLocation

Clause 8.2.4.2.10

Used to indicate the AEF location.

CommunicationType

Clause 8.2.4.3.5

Used to indicate the communication type used by the API.

ProblemDetails

3GPP TS 29.122 [14]

Used to represent additional information and details on an error response.

SupportedFeatures

3GPP TS 29.571 [19]

Used to negotiate the applicability of optional features defined in table 8.1.6-1.

serviceAPIDescriptions

array(ServiceAPIDescription)

O

1..N

Description of the service API as published by the service. (NOTE)

NOTE: For the CAPIF_Discover_Service_API, the supportedFeatures attribute of the ServiceAPIDescription data type shall be provided in the HTTP GET response of a successful query. In addition, the supportedFeatures attribute may include one or more supported feature(s) as defined in clause 8.1.6.

1

ApiSupportedFeatureQuery

Indicates the support of the query filter indicating the supported feature(s) of a service API.