openapi: 3.0.1
info:
title: AE
description: API for AE resource management
version: '0.1'
servers:
- url: 'http://cse-address:8080'
paths:
/csename:
post:
description: Create AE Resource
parameters:
- name: X-M2M-Origin
in: header
required: true
style: simple
explode: false
schema:
type: string
example: CAdmin
- name: X-M2M-RVI
in: header
required: false
style: simple
explode: false
schema:
type: string
example: '3'
- name: X-M2M-RI
in: header
required: false
style: simple
explode: false
schema:
type: string
example: '1234'
requestBody:
content:
application/json;ty=2:
schema:
type: object
examples:
'0':
value: |-
{
"m2m:ae" : {
"rn": "aename",
"api": "N01.com.company.aename ",
"lbl": ["key1", "key2"],
"rr": true,
"srv": ["3"],
"poa": ["http://cse-address:8080"]
}
}
responses:
'201':
description: Auto generated using Swagger Inspector
content:
application/json:
schema:
type: object
properties:
'm2m:rce':
type: object
properties:
'm2m:ae':
type: object
properties:
rr:
type: boolean
poa:
type: array
items:
type: string
aei:
type: string
ty:
type: integer
lt:
type: string
et:
type: string
ct:
type: string
srv:
type: array
items:
type: string
lbl:
type: array
items:
type: string
ri:
type: string
pi:
type: string
api:
type: string
rn:
type: string
examples:
'with no rcn or rcn=1 in the request':
value: >-
{"m2m:ae": {"rn": "temperature", "api":
"N01.com.company.temperature ", "lbl": ["key1", "key2"],
"rr": true, "srv": ["3"], "poa":
["http://192.168.1.30:8080"], "ri": "CAdmin", "ct":
"20210330T153934,791690", "lt": "20210330T153934,791690",
"et": "20220330T153934,791714", "pi": "id-in", "ty": 2,
"aei": "CAdmin"}}
'with rcn=0 in the request':
value: >-
{}
'with rcn=2 in the request':
value: >-
{"m2m:ae": "csename/aename"}
'with rcn=3 in the request':
value: >-
{"m2m:rce" {"m2m:ae": {"rn": "aename", "api": "N01.com.company.aename ",
"lbl": ["key1", "key2"], "rr": true, "srv": ["3"], "poa": ["http://cse-address:8080"],
"ri": "CAdmin", "ct": "20210330T153934,791690", "lt": "20210330T153934,791690", "et": "20220330T153934,791714", "pi": "cse-id", "ty": 2,
"aei": "CAdmin"} "uri": "mn-name/ae_sensor"}}
servers:
- url: 'http://cse-address:8080'
servers:
- url: 'http://cse-address:8080'
/csename/aename:
get:
description: Retrieve AE Resource
parameters:
- name: X-M2M-Origin
in: header
required: true
style: simple
explode: false
schema:
type: string
example: CAdmin
- name: X-M2M-RVI
in: header
required: false
style: simple
explode: false
schema:
type: string
example: '3'
- name: X-M2M-RI
in: header
required: false
style: simple
explode: false
schema:
type: string
example: '1234'
responses:
'200':
description: Retrieve AE Response
content:
application/json:
examples:
with no rcn or rcn=1 in the request:
value: |-
{
"m2m:ae": {
"rn": "aename",
"api": "N01.com.company.aename ",
"lbl": ["key1", "key2"],
"rr": true,
"srv": ["3"],
"poa": ["http://cse-address:8080"],
"ri": "CAdmin",
"ct": "20210330T153934,791690",
"lt": "20210330T153934,791690",
"et": "20220330T153934,791714",
"pi": "cse-id",
"ty": 2,
"aei": "CAdmin"
}
}
with rcn=4 in the request:
value: |-
{
"m2m:ae": {
"rn": "aename",
"api": "N01.com.company.aename ",
"lbl": ["key1", "key2"],
"rr": true,
"srv": ["3"],
"poa": ["http://cse-address:8080"],
"ri": "CAdmin",
"ct": "20210406T171115,934044",
"lt": "20210406T171115,934044",
"et": "20220406T171115,934064",
"pi": "cse-id",
"ty": 2,
"aei": "CAdmin",
"m2m:cnt":
[{"rn": "data1",
"lbl": ["API"],
"ri": "cnt7407517254520235341",
"ct": "20210407T073116,754629",
"lt": "20210407T073116,754629",
"et": "20220407T073116,754662",
"pi": "CAdmin",
"st": 0,
"ty": 3,
"cni": 0,
"cbs": 0
},
{
"rn": "data2",
"lbl": ["API2"],
"ri": "cnt446121489468649928",
"ct": "20210407T073158,811116",
"lt": "20210407T073158,811116",
"et": "20220407T073158,811187",
"pi": "CAdmin",
"st": 0,
"ty": 3,
"cni": 0,
"cbs": 0
}]
}
}
servers:
- url: 'http://cse-address:8080'
put:
description: Update AE resource
parameters:
- name: X-M2M-Origin
in: header
required: false
style: simple
explode: false
schema:
type: string
example: CAdmin
- name: X-M2M-RVI
in: header
required: false
style: simple
explode: false
schema:
type: string
example: '3'
- name: X-M2M-RI
in: header
required: false
style: simple
explode: false
schema:
type: string
example: '1234'
requestBody:
content:
application/json:
schema:
type: string
examples:
'0':
value: |-
{
"m2m:ae" : {
"lbl": ["aename bedroom"],
"poa": ["http://192.168.1.50:9090"]
}
}
responses:
'200':
description: Update AE Response
content:
application/json:
examples:
with no rcn or rcn=1 in the request:
value: |-
{
"m2m:ae": {
"rn": "aename",
"api": "N01.com.company.aename ",
"lbl": ["aename bedroom"],
"rr": true,
"srv": ["3"],
"poa": ["http://192.168.1.50:9090"],
"ri": "CAdmin",
"ct": "20210406T171115,934044",
"lt": "20210407T080109,896281",
"et": "20220406T171115,934064",
"pi": "cse-id",
"ty": 2,
"aei": "CAdmin"
}
}
with rcn=0 in the request:
value: ''
servers:
- url: 'http://cse-address:8080'
delete:
description: Delete AE
parameters:
- name: X-M2M-Origin
in: header
required: false
style: simple
explode: false
schema:
type: string
example: CAdmin
- name: X-M2M-RVI
in: header
required: false
style: simple
explode: false
schema:
type: string
example: '3'
- name: X-M2M-RI
in: header
required: false
style: simple
explode: false
schema:
type: string
example: '1234'
responses:
'200':
description: Delete AE response
content:
application/json:
examples:
with no rcn or rcn=0 in the request:
value: ''
with rcn=1 in the request:
value: |-
{
"m2m:ae": {
"rn": "aename",
"api": "N01.com.company.aename ",
"lbl": ["key1", "key2"],
"rr": true,
"srv": ["3"],
"poa": ["http://cse-address:8080"],
"ri": "C8r12WReyGd",
"ct": "20210407T090236,657104",
"lt": "20210407T090236,657104",
"et": "20220407T090236,657145",
"pi": "cse-id",
"ty": 2,
"aei": "C8r12WReyGd"
}
}
servers:
- url: 'http://cse-address:8080'
servers:
- url: 'http://cse-address:8080'