summary:Query multiple Application Mobility Service resources.
description:The GET method is to retrieve information about the registered Application Mobility Service. Upon success, the response contains entity body with the list of application mobility services that are present for the requestor.
summary:Create an Application Mobility Service resource.
description:The POST method is used to create a new application mobility service for the service requester. Upon success, the response contains entity body of created application mobility service with the service ID.
summary:Read an Application Mobility Service resource.
description:The GET method is used to retrieve information about this individual application mobility service. Upon success, the response contains entity body with the data type describing the registered Application Mobility Service.
description:It uniquely identifies the created individual application mobility service
required:true
style:simple
description:The unique identifier of the appMobilityServiceId.
schema:
type:string
put:
summary:Update an individual Application Mobility Service resource.
description:The PUT method is used to update the existing individual application mobility service. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request.
description:It uniquely identifies the created individual application mobility service
required:true
style:simple
description:The unique identifier of the appMobilityServiceId.
schema:
type:string
responses:
delete:
summary:Delete an individual Application Mobility Service resource.
description:The DELETE method is used to deregister the individual application mobility service, and delete the resource that represents the individual application mobility service.
description:The unique identifier of the appMobilityServiceId.
schema:
$ref:'#/components/schemas/ProblemDetails'
deprecated:false
parameters:[]
type:string
/subscriptions:
get:
summary:Retrieve information of multiple subscriptions to notifications of Application Mobility Service event.
description:The GET method is used to retrieve information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor.
summary:Subscribe to notifications of Application Mobility Service event.
description:The POST method is used to create a new subscription to Application Mobility Service notifications. Upon success, the response contains entity body describing the created subscription.
summary:Read information of subscription of Application Mobility Service.
description:The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription.
description:update the existing individual subscription.
operationId:sub_byIdPUT
$ref:'#/components/responses/429'
parameters:
-name:subscriptionId
in:path
description:Refers to created subscription, where the AMS API allocates a unique resource name for this subscription
required:true
style:simple
description:The unique identifier of the subscriptionId.
schema:
type:string
put:
summary:Update an individual subscription to notification of Application Mobility Service event.
description:The PUT method is used to update the existing individual subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new subscription parameters received within the message body of the PUT request.
description:The unique identifier of the subscriptionId.
schema:
$ref:'#/components/schemas/ProblemDetails'
deprecated:false
type:string
delete:
summary:Terminate an individual subscription to notification of Application Mobility Service event.
description:The DELETE method is used to cancel the existing individual subscription. Cancellation can be made by deleting the resource that represents existing individual subscription.
operationId:SubscriptionsDELETESubscriptionid
tags:
-subscriptions
summary:'canceltheexistingindividualsubscription'
description:cancel the existing individual subscription
operationId:sub_byIdDELETE
responses:
'204':
$ref:'#/components/responses/204'
'401':
$ref:'#/components/responses/401'
'403':
$ref:'#/components/responses/403'
'404':
$ref:'#/components/responses/404'
'429':
$ref:'#/components/responses/429'
parameters:
-name:subscriptionId
in:path
description:Refers to created subscription, where the AMS API allocates a unique resource name for this subscription
required:true
style:simple
description:The unique identifier of the subscriptionId.
schema:
type:string
/queries/adjacent_app_instances:
get:
summary:Read information of adjacent application instance(s).
description:The GET method is to retrieve the information of adjacent application instances. Upon success, the response contains entity body with the list of available application instance information.
description:The notification was delivered successfully. The response body shall be empty.
headers:{}
content:{}
'401':
description:It is used when the client did not submit credentials.'
headers:{}
content:
application/json:
schema:
$ref:'#/components/schemas/ProblemDetails'
type:object
properties:{}
'401':
$ref:'#/components/responses/401'
'403':
description:operation is not allowed given the current status of the resource.'
headers:{}
content:
application/json:
schema:
$ref:'#/components/schemas/ProblemDetails'
$ref:'#/components/responses/403'
'404':
description:Used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers:{}
content:
application/json:
schema:
$ref:'#/components/schemas/ProblemDetails'
'406':
description:Used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers:{}
content:
application/json:
schema:
$ref:'#/components/schemas/ProblemDetails'
$ref:'#/components/responses/404'
'429':
description:Used when a rate limiter has triggered.'
headers:{}
content:
application/json:
schema:
$ref:'#/components/schemas/ProblemDetails'
$ref:'#/components/responses/429'
parameters:[]
components:
schemas:
AdjacentAppInfoSubscription.links:
title:AdjacentAppInfoSubscription.links
required:
-self
MobilityStatus1_:
type:object
properties:
self:
$ref:'#/components/schemas/LinkType'
description:Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
AdjacentAppInfoSubscription.filterCriteria:
title:AdjacentAppInfoSubscription.filterCriteria
status:
type:integer
enum:
-1
-2
-3
description:'IndicatethestatusoftheUEmobility:
1=INTERHOST_MOVEOUT_TRIGGERED
2=INTERHOST_MOVEOUT_COMPLETED
3=INTERHOST_MOVEOUT_FAILED
'
x-enum-descriptions:
-1 = INTERHOST_MOVEOUT_TRIGGERED
-2 = INTERHOST_MOVEOUT_COMPLETED
-3 = INTERHOST_MOVEOUT_FAILED
required:
-status
AssociateId:
type:string
description:The data type of AssociateId is defined in ETSI GS MEC 012 [6].
AppMobilityServiceLevel1_:
type:object
properties:
appInstanceId:
type:string
description:List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
description:URI selected by the service consumer to receive notifications on the subscribed Application Mobility Service. This shall be included both in the request and in response.
requestTestNotification:
type:boolean
description:Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009, as described in clause 6.12a.
websockNotifConfig:
$ref:'#/components/schemas/WebsockNotifConfig'
expiryDeadline:
description:Identifies a boundary after which the subscription will expire.
description:It specifies the communication interface of application instance.
appInstanceId:
format:uri
description:A URI reference according to IETF RFC 3986 that identifies the problem type
title:
type:string
description:Identifier of the application instance.
mecHostInformation:
$ref:'#/components/schemas/MECHostInformation'
registeredInstanceId:
description:A short, human-readable summary of the problem type
status:
type:integer
format:uint32
description:The HTTP status code for this occurrence of the problem
detail:
type:string
description:dentifier of the application instance that registers to the AMS, which is instantiated from the application descriptor identified by the attribute "appDId".
AppMobilityServiceLevel:
title:AppMobilityServiceLevel
enum:
-APP_MOBILITY_NOT_ALLOWED
-APP_MOBILITY_WITH_CONFIRMATION
-APP_MOBILITY_WITHOUT_CONFIRMATION
description:A human-readable explanation specific to this occurrence of the problem
instance:
type:string
description:This attribute provides an option for the application instance (server) to communicate with the application client before relocating this application instance to another MEC host.
examples:
-APP_MOBILITY_NOT_ALLOWED
CommunicationInterface.IpAddresses:
title:CommunicationInterface.IpAddresses
required:
-host
-port
format:uri
description:A URI reference that identifies the specific occurrence of the problem
description:Identifier of the application instance.
type:string
description:Identifier of the application instance that registers the Application Mobility Service.
associateId:
type:array
items:
$ref:'#/components/schemas/AssociateId'
description:0 to N identifiers to associate the information for specific UE(s) and flow(s).
mobilityStatus:
appDId:
description:Identifier of the application descriptor.
type:string
appInstanceCommLink:
description:It specifies the communication interface of application instance.
type:array
minItems:1
items:
$ref:'#/components/schemas/MobilityStatus'
description:In case mobilityStatus is not included in the subscription request, the default value 1 = INTER_HOST_MOBILITY_TRIGGERED shall be used and included in the response.
description:List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
WebsockNotifConfig:
type:object
properties:
websocketUri:
description:Set by AMS to indicate to the service consumer the Websocket URI to be used for delivering notifications.
description:The MEC host where the application instance is running on.
$ref:'#/components/schemas/MECHostInformation'
registeredInstanceId:
description:Identifier of the application instance that registers to the AMS, which is instantiated from the application descriptor identified by the attribute "appDId".
type:string
format:uri
requestWebsocketUri:
type:boolean
description:Set to true by the service consumer to indicate that Websocket delivery is requested.
description:Shall be set to "MobilityProcedureSubscription".
type:string
callbackReference:
description:URI selected by the service consumer to receive notifications on the subscribed Application Mobility Service. See note.
type:string
format:uri
description:URI selected by the service consumer to receive notifications on the subscribed Application Mobility Service. This shall be included both in the request and in response.
description:Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009, as described in clause 6.12a.
websockNotifConfig:
description:Provides details to negotiate and signal the use of a Websocket connection between AMS and the service consumer for notifications.
description:Provides details to negotiate and signal the use of a Websocket connection between AMS and the service consumer for notifications. See note.
$ref:'#/components/schemas/WebsockNotifConfig'
_links:
$ref:'#/components/schemas/_links'
filterCriteria:
$ref:'#/components/schemas/FilterCriteria'
expiryDeadline:
description:Identifies a boundary after which the subscription will expire.
description:Provides details to negotiate and signal the use of a Websocket connection between AMS and the service consumer for notifications. See note.
$ref:'#/components/schemas/WebsockNotifConfig'
_links:
$ref:'#/components/schemas/_links'
filterCriteria:
$ref:'#/components/schemas/FilterCriteria1'
expiryDeadline:
description:Identifies a boundary after which the subscription will expire.
$ref:'#/components/schemas/TimeStamp'
associateId:
type:array
description:1 to N identifiers to associate the information for specific
items:
$ref:'#/components/schemas/AssociateId'
mobilityStatus:
description:Indicate the status of the UE mobility. Values are defined as following 1 = INTERHOST_MOVEOUT_TRIGGERED. 2 = INTERHOST_MOVEOUT_COMPLETED. 3 = INTERHOST_MOVEOUT_FAILED. Other values are reserved.
description:Set by AMS to indicate to the service consumer the Websocket URI to be used for delivering notifications.
type:string
format:uri
requestWebsocketUri:
description:Set to true by the service consumer to indicate that Websocket delivery is requested.
type:boolean
ServiceConsumerId:
description:The identifier of service consumer requesting the Application Mobility Service, i.e. either the application instance ID or the MEC platform ID.
type:object
properties:
appInstanceId:
description:If present, it represents the identifier of the application instance registering the Application Mobility Service.
type:string
mepId:
description:If present, it represents the identifier of the MEC platform registering the Application Mobility Service.
description:Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
type:object
properties:
appInstanceId:
type:string
description:If present, it represents the identifier of the application instance registering the Application Mobility Service.
mepId:
type:string
description:If present, it represents the identifier of the MEC platform registering the Application Mobility Service.
description:The identifier of service consumer requesting the application mobility service, i.e. either the application instance ID or the MEC platform ID.
RegistrationInfo:
title:RegistrationInfo
self:
description:Self-referring URI. The URI shall be unique within the AMS API as it acts as an ID for the subscription.
$ref:'#/components/schemas/LinkType'
required:
-serviceConsumerId
-self
FilterCriteria:
description:List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
type:object
properties:
appMobilityServiceId:
appInstanceId:
description:Identifier of the application instance that registers the Application Mobility Service.
type:string
description:The identifier of registered application mobility service. Shall be absent in POST requests, and present otherwise.
deviceInformation:
associateId:
description:0 to N identifiers to associate the information for specific UE(s) and flow(s).
description:If present, it specifies the device served by the application instance which is registering is registering the Application Mobility Service.
expiryTime:
type:integer
description:If present, it indicates the time of Application Mobility Service expiration from the time of registration accepted.The value "0" means infinite time, i.e. no expiration.The unit of expiry time is one second.
description:List of hyperlinks related to the resource.
FilterCriteria1:
description:List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
type:object
properties:
appInstanceId:
description:Identifier of the application instance that registers to the Application Mobility Service.
type:string
Subscription:
description:The service consumer's subscriptions.
type:object
properties:
href:
description:The URI referring to the subscription.
description:A short, human-readable summary of the problem type
type:
Query.Exclude_fields1:
description:Complex attributes to be excluded from the response. See clause 6.18 in ETSI GS MEC 009 [4] for details. The API producer should support this parameter.
name:exclude_fields
in:query
required:false
x-exportParamName:Query.Exclude_fields1
schema:
type:string
description:A URI reference according to IETF RFC 3986 that identifies the problem type