Newer
Older
info:
title: "ETSI GS MEC 029 Fixed Access Information API"
version: 2.1.1
description: "ETSI GS MEC 029 Fixed Access Information API described using OpenAPI."
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
contact:
url: https://forge.etsi.org/rep/mec/gs029-fai-api
externalDocs:
description: "ETSI GS MEC 029 Fixed Access Information API, v2.1.1"
url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/029/02.01.01_60/gs_mec029v020101p.pdf'
openapi: 3.0.0
servers:
- url: 'https://localhost/fai/v1'
tags:
- name: Queries
- name: Subscription
27
28
29
30
31
32
33
34
35
36
37
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
summary: 'Retrieve information on the available fixed access networks.'
description: 'Retrieve information on the available fixed access networks.'
operationId: fa_infoGET
parameters:
- in: query
name: customerPremisesInfo
schema:
type: array
items:
$ref: '#/components/schemas/CpInfo'
required: false
description: 'Comma separated list of customer premises information'
- in: query
name: lastMileTech
schema:
type: array
items:
type: integer
required: false
description: 'Comma separated list of last mile technologies.'
- in: query
name: interfaceType
schema:
type: array
items:
type: integer
description: 'Comma separated list of interface types.'
- in: query
name: dsbw
schema:
type: array
items:
type: integer
required: false
description: 'Comma separated list of the bandwidth (in Mbps) from the network towards the customer site.'
- in: query
name: usbw
schema:
type: array
items:
type: integer
required: false
description: 'Comma separated list of the bandwidth (in Mbps) from the customer site towards the network.'
- in: query
name: latency
schema:
type: array
items:
type: integer
required: false
description: 'Comma separated list of the maximum baseline latency (in ms) between customer site and service edge node.'
responses:
'200':
description: 'A response body containing the FAI is returned. '
content:
application/json:
schema:
$ref: '#/components/schemas/FaInfo'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
/queries/device_info:
get:
tags:
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
summary: 'retrieve information on the devices that are connected to a fixed access network.'
description: 'retrieve information on the devices that are connected to a fixed access network.'
operationId: device_infoGET
parameters:
- in: query
name: gwId
schema:
type: array
items:
type: string
required: false
description: 'Comma separated list of gateway identifier'
- in: query
name: deviceId
schema:
type: array
items:
type: string
required: false
description: 'Comma separated list of device identifier.'
- in: query
name: deviceStatus
schema:
type: array
items:
type: integer
description: 'Comma separated list of device status.'
responses:
'200':
description: 'A response body containing the device information is returned'
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceInfo'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/queries/cable_line_info:
get:
tags:
- 'Cable line info'
summary: 'It Queries information about the cable line of a fixed access network.'
description: 'It Queries information about the cable line of a fixed access network.'
operationId: cable_line_infoGET
parameters:
- in: query
name: customerPremisesInfo
schema:
type: array
items:
$ref: '#/components/schemas/CpInfo'
required: false
description: 'Comma separated list of customer premises information'
- in: query
name: cmId
schema:
type: array
items:
type: string
required: false
description: 'Comma separated list of Cable Modem identifiers.'
responses:
'200':
description: 'A response body containing the cable line information is returned.'
content:
application/json:
schema:
$ref: '#/components/schemas/CableLineInfo'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
/queries/optical_network_info:
get:
tags:
- 'Optical network info'
summary: 'used to query information about the optical network.'
Loading
Loading full blame…