summaryrefslogtreecommitdiffstats
path: root/kubernetes/dcaegen2-services/resources/external/schemas/sa88-rel16/PerMeasJobCtlMnS.yaml
blob: b6abe58b22ae893e3add0f00d1d7417fdcb95ca9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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
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
135
136
137
138
139
140
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
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
openapi: 3.0.1
info:
  title: TS 28.550 Performance Measurement Job Control Service
  version: 16.5.0
  description: >-
    OAS 3.0.1 specification of the Performance Measurement Job Control Service
    @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    All rights reserved.
externalDocs:
  description: 3GPP TS 28.550 V16.5.0; Performance assurance
  url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.550/
servers:
  - url: 'http://{URI-DN-prefix}/{root}/PerfMeasJobCtrlMnS/v1650/{LDN-first-part}'
    variables:
      URI-DN-prefix:
        description: See subclause 4.4 of TS 32.158
        default: example.com
      root:
        description: See subclause 4.4 of TS 32.158
        default: 3GPPManagement
      LDN-first-part:
        description: See subclause 4.4 of TS 32.158
        default: ''
paths:
  /measJobs:
    post:
      summary: Create a measurement job
      description: To create a measurement job the representation of the measurement job is POSTed on the /measJobs collection resource.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/measJobCreation-RequestType'
      responses:
        '201':
          description: Success case ("201 Created"). The representation of the newly created measurement job resource shall be returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/measJobCreation-ResponseType'
        '202':
          description: Partial success case ("202 Partically created"). The representation of the newly created measurement job resource with unsupported list shall be returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/measJobCreation-ResponseType'
        default:
          description: Error case.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-ResponseType'
    get:
      summary: Read resources of measurement jobs
      description: 'With HTTP GET, resources of measurement jobs are read. The resources to be read are identified with the path component (base resource) and the query component (jobIdList) of the URI. The fields query component allows to select the resource properties to be returned.'
      parameters:
        - name: jobIdList
          in: query
          description: This parameter identifies the list of jobId to select the resources from the collection resources identified with the path component of the URI.
          required: true
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: 'Success case ("200 OK"). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/measJobsRetrieval-ResponseType'
        default:
          description: Error case.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-ResponseType'
  '/measJobs/{jobId}':
    get:
      summary: Read resource of a single measurement job
      description: 'With HTTP GET, resource of a measurement job is read. The resource to be read is identified with the path component of the URI.'
      parameters:
        - name: jobId
          in: path
          description: Identifies the measurement job to be read.
          required: true
          schema:
            $ref: '#/components/schemas/uri-Type'
      responses:
        '200':
          description: 'Success case ("200 OK"). The resource identified in the path for retrieval is returned in the response message body. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/measJobsRetrieval-ResponseType'
        default:
          description: Error case.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-ResponseType'
    delete:
      summary: Delete a single measurement job
      description: The measurement job is deleted by deleting the corresponding measurement job resource. The resource to be deleted is identified with the path component of the URI.
      parameters:
        - name: jobId
          in: path
          description: Identifies the measurement job to be deleted.
          required: true
          schema:
            $ref: '#/components/schemas/uri-Type'
      responses:
        '204':
          description: Success case ("204 No Content"). The measurement job resource has been deleted. The response message body is absent.
        default:
          description: Error case.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-ResponseType'
components:
  schemas:
    dateTime-Type:
      type: string
      format: date-Time
    uri-Type:
      type: string
    measJobCreation-RequestType:
      type: object
      properties:
        iOCName:
          type: string
        iOCInstanceList:
          type: array
          items:
            $ref: '#/components/schemas/uri-Type'
        measurementCategoryList:
          type: array
          items:
            type: string
        reportingMethod:
          $ref: '#/components/schemas/reportingMethod-Type'
        granularityPeriod:
          type: integer
        reportingPeriod:
          type: integer
        startTime:
          $ref: '#/components/schemas/dateTime-Type'
        stopTime:
          $ref: '#/components/schemas/dateTime-Type'
        schedule:
          $ref: '#/components/schemas/schedule-Type'
        streamTarget:
          type: string
        priority:
          $ref: '#/components/schemas/priority-Type'
        reliability:
          type: string
    measJobCreation-ResponseType:
      type: object
      properties:
        unsupportedList:
          type: array
          items:
            $ref: '#/components/schemas/unsupportedMeas-Type'
    measJobsRetrieval-ResponseType:
      type: object
      properties:
        jobInfoList:
          type: array
          items:
            $ref: '#/components/schemas/measJobInfo-ResourceType'
    error-ResponseType:
      type: object
      properties:
        error:
          type: object
          properties:
            errorInfo:
              type: string
    measJobInfo-ResourceType:
      type: object
      properties:
        href:
          $ref: '#/components/schemas/uri-Type'
        iOCName:
          type: string
        iOCInstanceList:
          type: array
          items:
            $ref: '#/components/schemas/uri-Type'
        measurementCategoryList:
          type: array
          items:
            type: string
        reportingMethod:
          $ref: '#/components/schemas/reportingMethod-Type'
        granularityPeriod:
          type: integer
        reportingPeriod:
          type: integer
        startTime:
          $ref: '#/components/schemas/dateTime-Type'
        stopTime:
          $ref: '#/components/schemas/dateTime-Type'
        schedule:
          $ref: '#/components/schemas/schedule-Type'
        streamTarget:
          type: string
        priority:
          $ref: '#/components/schemas/priority-Type'
        reliability:
          type: string
    schedule-Type:
      type: object
      properties:
        scheduleOption:
          $ref: '#/components/schemas/scheduleOption-Type'
        dailySchedule:
          type: array
          items:
            $ref: '#/components/schemas/timeInterval-Type'
        weeklySchedule:
          type: array
          items:
            $ref: '#/components/schemas/scheduleOfDay-Type'
    timeInterval-Type:
      type: object
      properties:
        intervalStart:
          type: string
          format: Time
        intervalEnd:
          type: string
          format: Time
    scheduleOfDay-Type:
      type: object
      properties:
        dayOfWeek:
          $ref: '#/components/schemas/dayOfWeek-Type'
        intervalsOfDay:
          type: array
          items:
            $ref: '#/components/schemas/timeInterval-Type'
    unsupportedMeas-Type:
      type: object
      properties:
        iOCInstance:
          $ref: '#/components/schemas/uri-Type'
        measurementTypeName:
          type: string
        reason:
          type: string
    reportingMethod-Type:
      type: string
      enum:
        - file
        - streaming
    priority-Type:
      type: string
      enum:
        - low
        - medium
        - high
    scheduleOption-Type:
      type: string
      enum:
        - daily
        - weekly
    dayOfWeek-Type:
      type: string
      enum:
        - Monday
        - Tuesday
        - Wednesday
        - Thursday
        - Friday
        - Saturday
        - Sunday