Newer
Older
/**
* @desc The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI
* @see http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/01.01.01_60/gs_mec012v010101p.pdf
*/
module RnisAPI_TypesAndValues {
// LibCommon
import from LibCommon_BasicTypesAndValues all;
/**
* @member type_ A URI reference according to IETF RFC 3986 that identifies the problem type
* @member title A short, human-readable summary of the problem type
* @member status The HTTP status code for this occurrence of the problem
* @member detail A human-readable explanation specific to this occurrence of the problem
* @member instance A URI reference that identifies the specific occurrence of the problem
* @see IETF RFC 7807 Clause 3. The Problem Details JSON Object
} with {
variant (type_) "name as 'type'";
}
/**
* @desc
* @member timeStamp
* @member appInsId
* @member ecgi
*/
type record PlmnInfo {
TimeStamp timeStamp optional,
AppInsId appInsId,
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
}
/**
* @desc
* @member timeStamp
* @member appInsId
* @member requestId
* @member cellUserInfo
*/
type record RabInfo {
TimeStamp timeStamp optional,
AppInsId appInsId,
RequestId requestId,
CellUserInfo cellUserInfo optional
}
/**
* @desc
* @member timeStamp
* @member appInsId
* @member ecgi
*/
type record S1BearerInfo {
TimeStamp timeStamp optional,
S1UeInfo s1UeInfo
}
/**
* @desc The information on users per cell
* @member tempUeId
* @member associateId
* @member ecgi
* @member s1BearerInfoDetailed
*/
type record S1UeInfo_ {
TempUeId tempUeId optional,
type record of S1UeInfo_ S1UeInfo;
/**
* @desc Information on UEs in the specific cell
* @member erabId The element that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413
* @member enbInfo S1 bearer information on eNB side
* @member sGwInfo S1 bearer information on GW side
type record of S1BearerInfoDetailed_ S1BearerInfoDetailed;
type UInt32 ErabId;
/**
* @desc
* @member mmec MMEC as defined in ETSI TS 136 413
* @member mtmsi M-TMSI as defined in ETSI TS 136 413
*/
type record of TempUeId_ TempUeId;
/**
* @desc
* @member ipAddress eNB transport layer address of this S1 bearer
* @member tunnelId eNB GTP-U TEID of this S1 bearer
*/
type record S1EnbInfo {
}
/**
* @desc
* @member ipAddress SGW transport layer address of this S1 bearer
* @member tunnelId SGW GTP-U TEID of this S1 bearer
*/
type record SGwInfo {
}
/**
* @desc
* @member seconds The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
* @member nanoSeconds The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
*/
type record TimeStamp {
UInt32 seconds,
UInt32 nanoSeconds
}
/**
* @desc Unique identifier for the mobile edge application instance",
*/
/**
* @desc Unique identifier allocated by the Mobile Edge application for the Information request
*/
/**
* @desc The information on users per cell
* @member ecgi
* @member ueInfo
*/
type record of CellUserInfo_ CellUserInfo;
/**
* @desc E-UTRAN CelI Global Identifier as defined in 3GPP TS 36.413
* @member ecgi
*/
type record Ecgi {
Plmn plmn,
CellId cellId
}
/**
* @desc E-UTRAN CelI Global Identifier as defined in 3GPP TS 36.413
* @member mcc The Mobile Country Code part of PLMN Identity as defined in 3GPP TS 36.413
* @member mnc The Mobile Network Code part of PLMN Identity as defined in 3GPP TS 36.413
*/
type record Plmn {
/**
* @desc The E-UTRAN Cell Identity as a bit string (size (28)), as defined in 3GPP TS 36.413
*/
/**
* @desc Information on UEs in the specific cell
* @member associateId
* @member erabInfo
*/
type record UeInfo_ {
AssociateId associateId optional,
/**
* @desc Information on UEs in the specific cell
* @member type Numeric value (0-255) corresponding to specified type of identifier
* @member value Value for the identifier
*/
} with {
variant (type_) "name as 'type'";
variant (value_) "name as 'value'";
}
/**
* @desc Numeric value (0-255) corresponding to specified type of identifier
*/
type enumerated AssociateId_type {
RESERVED (0),
UE_IPV4_ADDRESS (1),
UE_IPV6_ADDRESS (2),
NATED_IP_ADDRESS (3),
GTP_TEID (4)
type record ErabInfo_ {
ErabId erabId,
ErabQosParameters erabQosParameters
}
type record of ErabInfo_ ErabInfo;
/**
* @desc
* @member qci QoS Class Identifier as defined in TS 23.401
* @member qci_information
*/
Qci qci,
QosInformation qosInformation optional
type record of ErabQosParameter ErabQosParameters;
/**
* @desc QoS Class Identifier as defined in TS 23.401
*/
type UInt32 Qci;
* @desc The QoS information for the E-RAB
* @member erabGbrDl This IE indicates the maximum downlink E-RAB Bit Rate as defined in TS 23.401 for this bearer
* @member erabGbrUl This IE indicates the maximum uplink E-RAB Bit Rate as defined in TS 23.401 for this bearer
* @member erabGbrDl This IE indicates the guaranteed downlink E-RAB Bit Rate as defined in TS 23.401 for this bearer
* @member erabMbrUl This IE indicates the guaranteed uplink E-RAB Bit Rate as defined in TS 23.401 for this bearer
*/
type record QosInformation_ {
UInt32 erabMbrDl,
UInt32 erabMbrUl,
UInt32 erabGbrDl,
UInt32 erabGbrUl
type record of QosInformation_ QosInformation;
* @member subscription
*/
type record SubscriptionLinkList {
Link links,
Subscription subscription optional
} with {
variant (links) "name as '_links'";
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
* @member expiryDeadline
*/
type record MeasRepUeSubscriptionPost {
CallbackReference callbackReference,
FilterCriteriaAssocTri filterCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
* @member expiryDeadline
*/
type record MeasRepUeSubscription {
CallbackReference callbackReference,
FilterCriteriaAssocTri filterCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc
* @member callbackReference
* @member eventType
* @member s1BearerSubscriptionCriteria
* @member expiryDeadline
*/
type record S1BearerSubscriptionPost {
CallbackReference callbackReference,
EventType eventType,
S1BearerSubscriptionCriteria s1BearerSubscriptionCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc
* @member callbackReference
* @member s1BearerSubscriptionCriteria
* @member expiryDeadline
*/
type record S1BearerSubscription {
CallbackReference callbackReference,
S1BearerSubscriptionCriteria s1BearerSubscriptionCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
*/
type record RabEstSubscription {
CallbackReference callbackReference,
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
* @member expiryDeadline
*/
type record RabEstSubscriptionPost {
CallbackReference callbackReference,
FilterCriteriaAssocQci filterCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
* @member expiryDeadline
*/
type record RabModSubscription {
CallbackReference callbackReference,
FilterCriteriaAssocQci filterCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
* @member expiryDeadline
*/
type record RabModSubscriptionPost {
CallbackReference callbackReference,
FilterCriteriaAssocQci filterCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
* @member expiryDeadline
*/
type record RabRelSubscription {
CallbackReference callbackReference,
FilterCriteriaAssocQci filterCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
* @member expiryDeadline
*/
type record RabRelSubscriptionPost {
CallbackReference callbackReference,
FilterCriteriaAssocQci filterCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
* @member expiryDeadline
*/
type record CaReConfSubscription {
CallbackReference callbackReference,
FilterCriteriaAssoc filterCriteria,
TimeStamp expiryDeadline optional
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
* @member expiryDeadline
*/
type record CaReConfSubscriptionPost {
CallbackReference callbackReference,
FilterCriteriaAssoc filterCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
* @member expiryDeadline
*/
type record CellChangeSubscriptionPost {
CallbackReference callbackReference,
FilterCriteriaAssocHo filterCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
* @member expiryDeadline
*/
type record CellChangeSubscription {
FilterCriteriaAssocHo filterCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
* @member expiryDeadline
*/
type record MeasTaSubscriptionPost {
CallbackReference callbackReference,
FilterCriteriaAssoc filterCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc
* @member callbackReference
* @member filterCriteria
* @member expiryDeadline
*/
type record MeasTaSubscription {
CallbackReference callbackReference,
FilterCriteriaAssocHo filterCriteria,
TimeStamp expiryDeadline optional
}
/**
* @desc URL selected by the Mobile Edge application to receive notifications on the subscribed RNIS information
*/
/**
* @desc List of hyperlinks related to the resource
* @member self_ URI referring to a resource
*/
type record Link {
}
/**
* @desc URI referring to a resource
*/
/**
* @desc A link to a subscription
* @member
* @member
*/
/**
* @desc Numeric value corresponding to specified type of subscription
* @member
* @member
* @member
* @member
* @member
* @member
*/
type enumerated SubscriptionType {
RESERVED,
CELL_CHANGE,
RAB_ESTABLISHMENT,
RAB_MODIFICATION,
RAB_RELEASE,
MEAS_REPORT_UE,
MEAS_TIMING_ADVANCE,
CA_RECONF,
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
}
/**
* @desc List of filtering criteria for the subscription
* @member appInsId
* @member associateId
* @member plmn
* @member cellId
*/
type record FilterCriteriaAssoc {
AppInsId appInsId,
AssociateId associateId,
Plmn plmn,
CellId cellId
}
/**
* @desc List of filtering criteria for the subscription
* @member appInsId
* @member associateId
* @member plmn
* @member cellId
* @member qci
*/
type record FilterCriteriaAssocQci {
AppInsId appInsId,
AssociateId associateId,
Plmn plmn,
CellId cellId,
Qci qci
}
/**
* @desc List of filtering criteria for the subscription
* @member appInsId
* @member associateId
* @member plmn
* @member cellId
* @member hoStatus
*/
type record FilterCriteriaAssocHo {
AppInsId appInsId,
AssociateId associateId,
Plmn plmn,
CellId cellId,
HoStatus hoStatus
}
/**
* @desc List of filtering criteria for the subscription
* @member appInsId
* @member associateId
* @member plmn
* @member cellId
* @member trigger
*/
AppInsId appInsId,
AssociateId associateId,
Plmn plmn,
CellId cellId,
Trigger trigger_
}
/**
* @desc List of filtering criteria for the subscription
* @member appInsId
* @member associateId
* @member plmn
* @member cellId
* @member trigger
*/
AssociateId associateId,
Plmn plmn,
CellId cellId,
}
/**
* @desc Description of the subscribed to event
*/
type enumerated HoStatus {
RESERVED,
IN_PREPARATION,
IN_EXECUTION,
COMPLETED,
REJECTED,
CANCELLED
}
/**
* @desc Description of the subscribed event
*/
type enumerated EventType {
RESERVED,
S1_BEARER_ESTABLISH,
S1_BEARER_MODIFY,
S1_BEARER_RELEASE
}
/**
* @desc Unique identifier for the mobile edge application instance
*/
type enumerated Trigger {
NOT_AVAILABLE,
PERIODICAL_REPORT_STRONGEST_CELLS,
PERIODICAL_REPORT_STRONGEST_CELLS_FOR_SON,
PERIODICAL_REPORT_CGI,
EVENT_A1,
EVENT_A2,
EVENT_A3,
EVENT_A4,
EVENT_A5,
EVENT_A6,
EVENT_B1,
EVENT_B2,
EVENT_C1,
EVENT_C2,
EVENT_W1,
EVENT_W2,
EVENT_W3
}
} with {
encode "JSON"
} // End of module RnisAPI_TypesAndValues