Newer
Older
title: ETSI GS MEC 021 Application Mobility Service API
description: ETSI GS MEC 021 Application Mobility Service API described using OpenAPI.
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
externalDocs:
description: ETSI GS MEC 021 Application Mobility Service API, v2.1.1
url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/021/02.01.01_60/gs_mec021v020101p.pdf
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
- url: https://localhost/amsi/v1
variables: {}
tags:
- name: adj-app-inst
description: Adjacent App instances
- name: app-mob-ser
description: Application Mobility Services
- name: app-mob-ser-der
description: Application Mobility Services Deregister task
- name: subscriptions
description: Subscription for Application Mobility Service
/queries/adjacent_app_instances:
get:
tags:
- adj-app-inst
summary: 'Retrieve information about this subscription.'
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
description: Retrieve information about this subscription.
operationId: adj_app_instGET
parameters:
- name: filter
in: query
description: Attribute-based filtering parameters according to ETSI GS MEC 011
style: form
explode: true
schema:
type: string
- name: all_fields
in: query
description: Include all complex attributes in the response.
style: form
explode: true
schema:
type: string
- name: fields
in: query
description: Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 011
style: form
explode: true
schema:
type: string
- name: exclude_fields
in: query
description: Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 011
style: form
explode: true
schema:
type: string
- name: exclude_default
in: query
description: Indicates to exclude the following complex attributes from the response See clause 6.18 in ETSI GS MEC 011 for details.
style: form
explode: true
schema:
type: string
responses:
'200':
description: A response body containing zero or more adjacent application instances
headers: {}
content:
application/json:
schema:
minItems: 0
type: array
items:
$ref: '#/components/schemas/AdjacentAppInstanceInfo'
description: ''
contentMediaType: application/json
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: 'Not Found : 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: 'Not Acceptable : 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'
'429':
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_mobility_services:
get:
summary: 'Retrieve information about the registered application mobility service.'
description: ' Retrieve information about the registered application mobility service.'
operationId: app_mobility_serviceGET
parameters:
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
- name: filter
in: query
description: Attribute-based filtering parameters according to ETSI GS MEC 011
style: form
explode: true
schema:
type: string
- name: all_fields
in: query
description: Include all complex attributes in the response.
style: form
explode: true
schema:
type: string
- name: fields
in: query
description: Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 011
style: form
explode: true
schema:
type: string
- name: exclude_fields
in: query
description: Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 011
style: form
explode: true
schema:
type: string
- name: exclude_default
in: query
description: Indicates to exclude the following complex attributes from the response See clause 6.18 in ETSI GS MEC 011 for details.
style: form
explode: true
schema:
type: string
description: Contains in an array the representations of zero or more application mobility services.
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RegistrationInfo'
description: ''
contentMediaType: application/json
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : 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'
description: 'Not Acceptable : 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'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
post:
summary: 'Create a new application mobility service for the service requester.'
description: Create a new application mobility service for the service requester.
requestBody:
description: Application mobility service to be created
content:
application/json:
schema:
$ref: '#/components/schemas/RegistrationInfo'
required: true
responses:
'201':
description: Successful response for application mobility service creation
$ref: '#/components/schemas/RegistrationInfo'
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : 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'
description: 'Not Acceptable : 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'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_mobility_services/{appMobilityServiceId}:
get:
tags:
- app-mob-ser
summary: 'Retrieve information about this individual application mobility service'
description: Retrieve information about this individual application mobility service
operationId: app_mobility_service_by_idGET
parameters:
- name: appMobilityServiceId
in: path
description: It uniquely identifies the created individual application mobility service
required: true
style: simple
schema:
type: string
responses:
description: Contains a representation of the application mobility service.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RegistrationInfo'
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : 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'
description: 'Not Acceptable : 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'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- app-mob-ser
summary: ' update the existing individual application mobility service'
description: ' update the existing individual application mobility service'
operationId: app_mobility_service_by_idPUT
parameters:
- name: appMobilityServiceId
in: path
description: It uniquely identifies the created individual application mobility service
style: simple
schema:
type: string
requestBody:
description: ''
$ref: '#/components/schemas/RegistrationInfo'
required: true
responses:
description: Contains a data type describing the updated application mobility service.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RegistrationInfo'
'400':
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : 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'
description: 'Not Acceptable : 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'
description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
delete:
tags:
- app-mob-ser
summary: ' deregister the individual application mobility service'
description: ' deregister the individual application mobility service'
operationId: app_mobility_service_by_idDELETE
parameters:
- name: appMobilityServiceId
in: path
description: It uniquely identifies the created individual application mobility service
required: true
style: simple
schema:
type: string
responses:
description: No Content
headers: {}
content: {}
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : 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'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/app_mobility_services/{appMobilityServiceId}/deregister_task:
post:
tags:
- app-mob-ser-der
summary: ' deregister the individual application mobility service'
description: ' deregister the individual application mobility service'
operationId: app_mobility_service_derPOST
parameters:
- name: appMobilityServiceId
in: path
description: It uniquely identifies the created individual application mobility service
required: true
style: simple
schema:
type: string
responses:
description: No Content
headers: {}
content: {}
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : 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'
description: 'Not Acceptable : 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'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
summary: 'Retrieve information about the subscriptions for this requestor.'
description: Retrieve information about the subscriptions for this requestor.
- name: subscriptionType
in: query
description: 'Query parameter to filter on a specific subscription type. Permitted values: mobility_proc or adj_app_info'
required: true
style: form
explode: true
schema:
type: string
description: Contains the list of links to requestor subscriptions.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionLinkList'
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : 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'
description: 'Not Acceptable : 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'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
post:
summary: 'Create a new subscription to Application Mobility Service notifications.'
description: Create a new subscription to Application Mobility Service notifications.
- $ref: '#/components/schemas/MobilityProcedureSubscription'
- $ref: '#/components/schemas/AdjacentAppInfoSubscription'
contentMediaType: application/json
required: true
description: Created subscription is described using the appropriate data type
headers: {}
oneOf:
- $ref: '#/components/schemas/MobilityProcedureSubscription'
- $ref: '#/components/schemas/AdjacentAppInfoSubscription'
contentMediaType: application/json
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : 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'
description: 'Not Acceptable : 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'
description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/subscriptions/{subscriptionId}:
get:
tags:
- subscriptions
summary: 'Retrieve information about this subscription.'
description: Retrieve information about this subscription.
operationId: sub_byIdGET
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
schema:
type: string
responses:
description: A response body containing data type describing the specific RNI event subscription
headers: {}
oneOf:
- $ref: '#/components/schemas/MobilityProcedureSubscription'
- $ref: '#/components/schemas/AdjacentAppInfoSubscription'
contentMediaType: application/json
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : 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'
description: 'Not Acceptable : 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'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- subscriptions
summary: 'update the existing individual subscription.'
description: update the existing individual subscription.
operationId: sub_byIdPUT
parameters:
- name: subscriptionId
in: path
description: Refers to created subscription, where the AMS API allocates a unique resource name for this subscription
style: simple
schema:
type: string
requestBody:
description: ''
- $ref: '#/components/schemas/MobilityProcedureSubscription'
- $ref: '#/components/schemas/AdjacentAppInfoSubscription'
contentMediaType: application/json
required: true
responses:
description: a response body containing data type describing the updated subscription
headers: {}
oneOf:
- $ref: '#/components/schemas/MobilityProcedureSubscription'
- $ref: '#/components/schemas/AdjacentAppInfoSubscription'
contentMediaType: application/json
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : 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'
description: 'Not Acceptable : 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'
description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
delete:
tags:
- subscriptions
summary: 'cancel the existing individual subscription'
description: cancel the existing individual subscription
operationId: sub_byIdDELETE
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
schema:
type: string
responses:
description: No Content
headers: {}
content: {}
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : 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'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
components:
schemas:
AdjacentAppInfoSubscription.links:
title: AdjacentAppInfoSubscription.links
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.
title: AdjacentAppInfoSubscription.filterCriteria
type: object
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.
title: AdjacentAppInfoSubscription
required:
- callbackReference
- filterCriteria
- subscriptionType
type: object
properties:
_links:
$ref: '#/components/schemas/AdjacentAppInfoSubscription.links'
callbackReference:
type: string
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.
$ref: '#/components/schemas/TimeStamp'
filterCriteria:
$ref: '#/components/schemas/AdjacentAppInfoSubscription.filterCriteria'
subscriptionType:
const: AdjacentAppInfoSubscription
description: Shall be set to "AdjacentAppInfoSubscription".
examples:
- AdjacentAppInfoSubscription
AdjacentAppInstanceInfo:
title: AdjacentAppInstanceInfo
- appDId
- appInstanceCommLink
- appInstanceId
description: Identifier of the application descriptor.
type: array
items:
$ref: '#/components/schemas/CommunicationInterface'
description: It specifies the communication interface of application instance.
description: Identifier of the application instance.
mecHostInformation:
$ref: '#/components/schemas/MECHostInformation'
AppMobilityServiceLevel:
enum:
- APP_MOBILITY_NOT_ALLOWED
- APP_MOBILITY_WITH_CONFIRMATION
- APP_MOBILITY_WITHOUT_CONFIRMATION
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
title: CommunicationInterface.IpAddresses
required:
- host
- port
type: object
properties:
host:
type: string
port:
type: integer
contentEncoding: int32
title: CommunicationInterface
type: object
type: array
items:
$ref: '#/components/schemas/CommunicationInterface.IpAddresses'
description: ''
title: MobilityProcedureSubscription.links
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
title: MobilityProcedureSubscription.filterCriteria
type: object
properties:
appInstanceId:
type: string
description: Identifier of the application instance that registers the application mobility service.
associateId:
minItems: 0
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the information for specific UE(s) and flow(s).
mobilityStatus:
minItems: 0
type: array
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.
title: MobilityProcedureSubscription
required:
- callbackReference
- filterCriteria
- subscriptionType
type: object
properties:
_links:
$ref: '#/components/schemas/MobilityProcedureSubscription.links'
callbackReference:
type: string
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.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteria:
$ref: '#/components/schemas/MobilityProcedureSubscription.filterCriteria'
subscriptionType:
const: MobilityProcedureSubscription
description: Shall be set to "MobilityProcedureSubscription".
examples:
- MobilityProcedureSubscription
enum:
- INTERHOST_MOVEOUT_TRIGGERED
- INTERHOST_MOVEOUT_COMPLETED
- INTERHOST_MOVEOUT_FAILED
type: string
description: Indicate the status of the UE mobility
examples:
- INTERHOST_MOVEOUT_TRIGGERED
title: RegistrationInfo.deviceInformation
required:
- associateId
type: object
properties:
associateId:
$ref: '#/components/schemas/AssociateId'
appMobilityServiceLevel:
$ref: '#/components/schemas/AppMobilityServiceLevel'
contextTransferState:
$ref: '#/components/schemas/contextTransferState'
title: RegistrationInfo.serviceConsumerId
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.
title: RegistrationInfo
required:
- serviceConsumerId
type: object
properties:
appMobilityServiceId:
type: string
description: The identifier of registered application mobility service. Shall be absent in POST requests, and present otherwise.
$ref: '#/components/schemas/RegistrationInfo.deviceInformation'
description: If present, it specifies the device served by the application instance which is registering the application mobility service.
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.
contentEncoding: int32
serviceConsumerId:
$ref: '#/components/schemas/RegistrationInfo.serviceConsumerId'
SubscriptionLinkList.links:
title: SubscriptionLinkList.links
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
description: List of hyperlinks related to the resource.
title: SubscriptionLinkList.subscription
required:
- href
- subscriptionType
type: object
properties:
href:
type: string
description: The URI referring to the subscription.
subscriptionType:
$ref: '#/components/schemas/subscriptionType'
title: SubscriptionLinkList
required:
- _links
type: object
properties:
_links:
$ref: '#/components/schemas/SubscriptionLinkList.links'
subscription:
minItems: 0
type: array
items:
$ref: '#/components/schemas/SubscriptionLinkList.subscription'
description: A link to a subscription.
enum:
- NOT_TRANSFERRED
- USER_CONTEXT_TRANSFER_COMPLETED
type: string
description: If present, it represents the state of transferring the user context to another application instance.
examples:
- NOT_TRANSFERRED
description: 'Numeric value (0 - 255) corresponding to specified type of subscription as following: 0 = RESERVED. 1 = MOBILITY_PROCEDURE. 2 = ADJACENT_APPINFO.'
examples:
- 0
properties:
type:
$ref: '#/components/schemas/Type'
value:
type: string
description: Value for the identifier.
type: string
description: The URI referring to the subscription.
description: "'This data type represents a type of link'"
- seconds
- nanoSeconds
type: object
type: integer
description: "'The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.'"
contentEncoding: int32
type: integer
description: "'The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.'"
contentEncoding: int32
description: "'This data type represents the time stamp as Unix-time since January 1, 1970, 00:00:00 UTC'"
type: string
description: Human-readable name of MEC host.
type: object
description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
description: "'The data type represents the parameters of MEC host information.'"
title: ProblemDetails
type: object
description: A human-readable explanation specific to this occurrence of the problem
description: A URI reference that identifies the specific occurrence of the problem
description: The HTTP status code for this occurrence of the problem
contentEncoding: int32
description: A short, human-readable summary of the problem type
description: A URI reference according to IETF RFC 3986 that identifies the problem type
Type:
title: Type
enum:
- UE_IPv4_ADDRESS
- UE_IPV6_ADDRESS
- NATED_IP_ADDRESS
- GTP_TEID
type: string
description: Numeric value (0-255) corresponding to specified type of identifier
examples:
- UE_IPv4_ADDRESS
security: