All API Provider Domains Registrations

/registrations

POST

Registers a new API provider domain by creating an API provider domain with API provider domain functions profiles.

Individual API Provider Domain Registration

/registrations/{registrationId}

PUT

Updates an individual API provider domain identified by {registrationId}

PATCH

Modifies an individual API provider domain identified by {registrationId}

DELETE

Deregisters an API provider domain by deleting the API provider domain and functions, identified by {registrationId}.

apiRoot

string

See clause 7.5

n/a

APIProviderEnrolmentDetails

M

1

Enrolment details of the API provider domain including individual API provider domain function details.

APIProviderEnrolmentDetails

M

1

201 Created

API provider domain registered successfully

The URI of the created resource shall be returned in the "Location" HTTP header.

The list of successfully registered individual API provider domain functions, registration specific failure information of failed API provider domain function registrations, are included in APIProviderEnrolmentDetails which is provided in the response body.

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

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/api-provider-management/<apiVersion>/registrations/{registrationId}

apiRoot

string

See clause 7.5

registrationId

string

Identifies an individual registered API Provider domain resource

n/a

APIProviderEnrolmentDetails

M

1

Updated details of the API provider domain.

APIProviderEnrolmentDetails

M

1

200 OK

API provider domain’s information updated successfully.

Updated details of the API provider domain is part of the APIProviderEnrolmentDetails, which is provided in the response body. The list of successfully updated individual API provider domain functions, registration update specific failure information of failed API provider domain function registration updates, are included in APIProviderEnrolmentDetails which is provided in the response body.

n/a

204 No Content

API provider domain’s information updated successfully.

n/a

307 Temporary Redirect

Temporary redirection, during resource modification. 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 modification. 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].

NOTE: The mandatory HTTP error status codes for the PUT 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.

n/a

n/a

n/a

204 No Content

The individual registered API provider domain matching the registrationId is deleted. All the individual API provider domain functions of the API provider domain are deleted.

n/a

307 Temporary Redirect

Temporary redirection, during resource termination. 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 termination. 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].

NOTE: The mandatory HTTP error status codes for the DELETE 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.

n/a

APIProviderEnrolmentDetailsPatch

M

1

Modified details of the API provider domain.

APIProviderEnrolmentDetails

M

1

200 OK

API provider domain’s information updated successfully.

Updated details of the API provider domain is part of the APIProviderEnrolmentDetails, which is provided in the response body. The list of successfully updated individual API provider domain functions, registration update specific failure information of failed API provider domain function registration updates, are included in APIProviderEnrolmentDetails which is provided in the response body.

n/a

204 No Content

API provider domain’s information modified successfully.

n/a

307 Temporary Redirect

Temporary redirection, during resource modification. 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 modification. 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].

NOTE: The mandatory HTTP error status codes for the HTTP PATCH 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.

APIProviderEnrolmentDetails

Clause 8.9.4.2.2

Represents the API provider domain’s enrolment details.

APIProviderEnrolmentDetailsPatch

Clause 8.9.4.2.5

Represents the list of modifications for the API provider domain’s enrolment details.

PatchUpdate

ApiProviderFuncRole

Clause 8.9.4.3.3

Indicates the role (e.g. AEF, APF, etc.) of an API provider domain function.

APIProviderFunctionDetails

Clause 8.9.4.2.3

Represents the API provider domain function’s details.

RegistrationInformation

Clause 8.9.4.2.4

Represents registration information of an individual API provider domain function.

SupportedFeatures

3GPP TS 29.571 [19]

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

apiProvDomId

string

O

0..1

API provider domain ID assigned by the CAPIF core function to the API management function while registering the API provider domain. Shall not be present in the HTTP POST request from the API management function to the CAPIF core function, to on-board itself. Shall be present in all other HTTP requests and responses.

regSec

string

M

1

Security information necessary for the CAPIF core function to validate the registration of the API provider domain. Shall be present in HTTP request from API management function to CAPIF core function for API provider domain registration.

apiProvFuncs

array(APIProviderFunctionDetails)

O

1..N

A list of individual API provider domain functions details. When included by the API management function in the HTTP request message, it lists the API provider domain functions that the API management function intends to register/update in registration or update registration procedure. When included by the CAPIF core function in the HTTP response message, it lists the API domain functions details that are registered or updated successfully.

apiProvDomInfo

string

O

0..1

Generic information related to the API provider domain such as details of the API provider applications.

suppFeat

SupportedFeatures

O

0..1

Used to negotiate the supported optional features of the API as described in clause 7.8.

This attribute shall be provided in the HTTP POST request and in the response of successful resource creation.

failReason

string

O

0..1

Registration or update specific failure information of failed API provider domain function registrations.

Shall be present in the HTTP response body if atleast one of the API provider domain function registration or update registration fails.

apiProvFuncId

string

O

0..1

API provider domain functionID assigned by the CAPIF core function to the API provider domain function while registering/updating the API provider domain. Shall not be present in the HTTP POST request from the API management function to the CAPIF core function, to register itself. Shall be present in all other HTTP requests and responses.

regInfo

RegistrationInformation

M

1

Information necessary for the CAPIF core function to register the API provider domain function.

This information shall be present in HTTP POST/PUT request from API management function to CAPIF core function for API provider domain registration. In the HTTP response message from CAPIF core function, shall include the updated registration information for API provider domain function.

apiProvFuncRole

ApiProviderFuncRole

M

1

Role of API provider domain function.

The role shall be present in the HTTP POST/PUT request that the API management function intends to register/update the API provider domain function as. CAPIF core function shall register the role of API provider domain function as per the request.

apiProvFuncInfo

string

O

0..1

Generic information related to the API provider domain function such as details of the API provider applications.

apiProvPubKey

string

M

1

Public Key of API Provider domain function.

apiProvCert

string

O

0..1

API provider domain function’s generic client certificate

apiProvFuncs

array(APIProviderFunctionDetails)

O

1..N

A list of individual API provider domain functions details. When included by the API management function in the HTTP request message, it lists the API provider domain functions that the API management function intends to register/update in registration or update registration procedure.

apiProvDomInfo

string

O

0..1

Generic information related to the API provider domain such as details of the API provider applications.

n/a

AEF

API provider function is API Exposing Function.

APF

API provider function is API Publishing Function.

AMF

API provider function is API Management Function.

1

PatchUpdate

Indicates the support of the PATCH method for updating an API Provider Domain Registration resource.