docs/offeredapis/api_serviceInventory/api.plantuml

   1 #
   2 #     Copyright (c) 2018 Orange
   3 #
   4 #     Licensed under the Apache License, Version 2.0 (the "License");
   5 #     you may not use this file except in compliance with the License.
   6 #     You may obtain a copy of the License at
   7 #
   8 #         http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #     Unless required by applicable law or agreed to in writing, software
  11 #     distributed under the License is distributed on an "AS IS" BASIS,
  12 #     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #     See the License for the specific language governing permissions and
  14 #     limitations under the License.
  15 #
  16
  17 @startuml
  18
  19 enum eventType {
  20    ServiceCreationNotification
  21    ServiceAttributeValueChangeNotification
  22    ServiceRemoveNotification
  23 }
  24
  25 class ErrorRepresentation {
  26    code:int
  27    reason:string
  28    message:string
  29    status:string
  30    referenceError:string
  31    @type:string
  32    @schemaLocation:string
  33 }
  34
  35 class Service {
  36    id:string
  37    href:string
  38    name:string
  39    type:string
  40    state:string
  41    @type:string
  42    @baseType:string
  43    @schemaLocation:string
  44 }
  45    Service --> "0-1" ServiceSpecificationRef : serviceSpecification
  46    Service --> "0-*" ServiceCharacteristic : characteristic
  47    Service --> "0-*" SupportingResource : supportingResource
  48    Service --> "0-*" RelatedPartyRef : relatedParty
  49
  50 class ServiceSpecificationRef {
  51    id:string
  52    href:string
  53    name:string
  54    version:string
  55    @referredType:string
  56    @schemaLocation:string
  57    invariantUUID:string
  58 }
  59
  60 class ServiceCharacteristic {
  61    name:string
  62    valueType:string
  63 }
  64    ServiceCharacteristic --> "0-1" Value : value
  65
  66 class SupportingResource {
  67    id:string
  68    href:string
  69    role:string
  70    name:string
  71    @referredType:string
  72    @schemaLocation:string
  73    status:string
  74    modelInvariantId:string
  75    modelVersionId:string
  76    modelCustomisationId:string
  77 }
  78
  79 class RelatedPartyRef {
  80    id:string
  81    href:string
  82    role:string
  83    @referredType:string
  84 }
  85
  86 class Value {
  87    @type:string
  88    @schemaLocation:string
  89    serviceCharacteristicValue:string
  90 }
  91
  92 class ListRelatedPartyRef {
  93    id:string
  94    role:string
  95 }
  96
  97 class ListServiceSpecificationRef {
  98    id:string
  99    name:string
 100 }
 101
 102 class ListService {
 103    id:string
 104    name:string
 105 }
 106    ListService --> "0-1" ListServiceSpecificationRef : serviceSpecification
 107    ListService --> "0-1" ListRelatedPartyRef : relatedParty
 108
 109 class ServiceInventoryEvent {
 110    id:string
 111    href:string
 112    name:string
 113    type:string
 114    state:string
 115 }
 116    ServiceInventoryEvent --> "1-1" RelatedPartyRef : relatedParty
 117
 118 class Notification {
 119    eventId:string
 120    eventDate:dateTime
 121 }
 122    Notification --> "1-1" eventType : eventType
 123    Notification --> "1-1" ServiceInventoryEvent : event
 124
 125 @enduml