docs/offeredapis/serviceOrder/apiServiceOrder.plantuml

   1 @startuml
   2
   3 enum ActionType {
   4    add
   5    modify
   6    delete
   7    noChange
   8 }
   9 enum StateType {
  10    acknowledged
  11    rejected
  12    pending
  13    held
  14    inProgress
  15    cancelled
  16    completed
  17    failed
  18    partial
  19 }
  20 enum RelationshipType {
  21    reliesOn
  22 }
  23 enum EventType {
  24    ServiceOrderCreationNotification
  25    ServiceOrderStateChangeNotification
  26    ServiceOrderItemStateChangeNotification
  27 }
  28 enum SeverityMessage {
  29    information
  30    error
  31 }
  32
  33 class ErrorRepresentation {
  34    code:int
  35    reason:string
  36    message:string
  37    status:string
  38    referenceError:string
  39    @type:string
  40    @schemaLocation:string
  41 }
  42
  43 class ServiceRelationship
  44    ServiceRelationship --> "1-1" RelationshipType : type
  45    ServiceRelationship --> "1-1" Service : service
  46
  47 class ServiceRef {
  48    id:string
  49    href:string
  50 }
  51
  52 class ServiceCharacteristic {
  53    name:string
  54    valueType:string
  55 }
  56    ServiceCharacteristic --> "0-1" Value : value
  57
  58 class RelatedParty {
  59    id:string
  60    href:string
  61    role:string
  62    name:string
  63    @referredType:string
  64 }
  65
  66 class ServiceSpecificationRef {
  67    id:string
  68    href:string
  69    name:string
  70    version:string
  71    @type:string
  72    @schemaLocation:string
  73    @baseType:string
  74 }
  75    ServiceSpecificationRef --> "0-1" TargetServiceSchema : targetServiceSchema
  76
  77 class Service {
  78    id:string
  79    href:string
  80    name:string
  81    serviceState:string
  82    @type:string
  83    @schemaLocation:string
  84 }
  85    Service --> "0-*" ServiceCharacteristic : serviceCharacteristic
  86    Service --> "0-*" ServiceRelationship : serviceRelationship
  87    Service --> "0-*" RelatedParty : relatedParty
  88    Service --> "0-1" ServiceSpecificationRef : serviceSpecification
  89
  90 class OrderItemRelationship {
  91    id:string
  92 }
  93    OrderItemRelationship --> "1-1" RelationshipType : type
  94
  95 class ServiceOrderItem {
  96    id:string
  97    percentProgress:string
  98    @type:string
  99    @schemaLocation:string
 100    @baseType:string
 101 }
 102    ServiceOrderItem --> "0-1" ActionType : action
 103    ServiceOrderItem --> "0-1" StateType : state
 104    ServiceOrderItem --> "0-*" OrderItemRelationship : orderItemRelationship
 105    ServiceOrderItem --> "1-1" Service : service
 106    ServiceOrderItem --> "0-*" OrderMessage : orderItemMessage
 107
 108 class ServiceOrder {
 109    id:string
 110    href:string
 111    externalId:string
 112    priority:string
 113    description:string
 114    category:string
 115    orderDate:dateTime
 116    completionDateTime:dateTime
 117    requestedStartDate:dateTime
 118    requestedCompletionDate:dateTime
 119    expectedCompletionDate:dateTime
 120    startDate:dateTime
 121    @baseType:string
 122    @type:string
 123    @schemaLocation:string
 124 }
 125    ServiceOrder --> "0-1" StateType : state
 126    ServiceOrder --> "0-*" RelatedParty : relatedParty
 127    ServiceOrder --> "0-*" OrderRelationship : orderRelationship
 128    ServiceOrder --> "0-*" ServiceOrderItem : orderItem
 129    ServiceOrder --> "0-*" OrderMessage : orderMessage
 130
 131 class OrderRelationship {
 132    type:string
 133    id:string
 134    href:string
 135    @referredType:string
 136 }
 137
 138 class TargetServiceSchema {
 139    @type:string
 140    @schemaLocation:string
 141 }
 142
 143 class Value {
 144    @type:string
 145    @schemaLocation:string
 146    serviceCharacteristicValue:string
 147 }
 148
 149 class CreateServiceOrderItem {
 150    id:string
 151    @type:string
 152    @schemaLocation:string
 153    @baseType:string
 154 }
 155    CreateServiceOrderItem --> "0-1" ActionType : action
 156    CreateServiceOrderItem --> "0-*" OrderItemRelationship : orderItemRelationship
 157    CreateServiceOrderItem --> "1-1" Service : service
 158
 159 class CreateServiceOrder {
 160    externalId:string
 161    priority:string
 162    description:string
 163    category:string
 164    requestedStartDate:dateTime
 165    requestedCompletionDate:dateTime
 166    @baseType:string
 167    @type:string
 168    @schemaLocation:string
 169 }
 170    CreateServiceOrder --> "0-*" RelatedParty : relatedParty
 171    CreateServiceOrder --> "0-*" OrderRelationship : orderRelationship
 172    CreateServiceOrder --> "0-*" CreateServiceOrderItem : orderItem
 173
 174 class Hub {
 175    id:string
 176    query:string
 177    callback:string
 178 }
 179
 180 class CreateHub {
 181    query:string
 182    callback:string
 183 }
 184
 185 class ServiceOrderSummary {
 186    id:string
 187    href:string
 188    externalId:string
 189    orderDate:dateTime
 190    completionDateTime:dateTime
 191 }
 192    ServiceOrderSummary --> "0-1" StateType : state
 193
 194 class ServiceOrderCreationNotification {
 195    eventId:string
 196    eventDate:dateTime
 197    eventType:string
 198 }
 199    ServiceOrderCreationNotification --> "1-1" ServiceOrderSummary : event
 200
 201 class Notification
 202
 203 class ServiceOrderStateChangeNotification {
 204    eventId:string
 205    eventDate:dateTime
 206    eventType:string
 207 }
 208    ServiceOrderStateChangeNotification --> "1-1" ServiceOrderSummary : event
 209
 210 class ServiceOrderItemSummary {
 211    id:string
 212 }
 213    ServiceOrderItemSummary --> "0-1" ActionType : action
 214    ServiceOrderItemSummary --> "0-1" StateType : state
 215    ServiceOrderItemSummary --> "1-1" Service : service
 216
 217 class ServiceOrderSummaryWithItem {
 218    id:string
 219    href:string
 220    externalId:string
 221    orderDate:dateTime
 222    completionDateTime:dateTime
 223 }
 224    ServiceOrderSummaryWithItem --> "0-1" StateType : state
 225    ServiceOrderSummaryWithItem --> "0-*" ServiceOrderItemSummary : orderItem
 226
 227 class ServiceOrderItemStateChangeNotification {
 228    eventId:string
 229    eventDate:dateTime
 230    eventType:string
 231 }
 232    ServiceOrderItemStateChangeNotification --> "1-1" ServiceOrderSummaryWithItem : event
 233
 234 class OrderMessage {
 235    code:string
 236    field:string
 237    messageInformation:string
 238    correctionRequired:boolean
 239 }
 240    OrderMessage --> "1-1" SeverityMessage : severity
 241
 242 @enduml