docs/offeredapis/api_serviceOrder/api.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 Error {
  34    code:int
  35    reason:string
  36    message:string
  37    status:string
  38    referenceError:string
  39 }
  40
  41 class ServiceRelationship
  42    ServiceRelationship --> "1-1" RelationshipType : type
  43    ServiceRelationship --> "1-1" Service : service
  44
  45 class ServiceRef {
  46    id:string
  47    href:string
  48 }
  49
  50 class ServiceCharacteristic {
  51    name:string
  52    valueType:string
  53 }
  54    ServiceCharacteristic --> "0-1" Value : value
  55
  56 class RelatedParty {
  57    id:string
  58    href:string
  59    role:string
  60    name:string
  61    @referredType:string
  62 }
  63
  64 class ServiceSpecificationRef {
  65    id:string
  66    href:string
  67    name:string
  68    version:string
  69    @type:string
  70    @schemaLocation:string
  71    @baseType:string
  72 }
  73    ServiceSpecificationRef --> "0-1" TargetServiceSchema : targetServiceSchema
  74
  75 class Service {
  76    id:string
  77    href:string
  78    name:string
  79    serviceState:string
  80    @type:string
  81    @schemaLocation:string
  82 }
  83    Service --> "0-*" ServiceCharacteristic : serviceCharacteristic
  84    Service --> "0-*" ServiceRelationship : serviceRelationship
  85    Service --> "0-*" RelatedParty : relatedParty
  86    Service --> "0-1" ServiceSpecificationRef : serviceSpecification
  87
  88 class OrderItemRelationship {
  89    id:string
  90 }
  91    OrderItemRelationship --> "1-1" RelationshipType : type
  92
  93 class ServiceOrderItem {
  94    id:string
  95    percentProgress:string
  96    @type:string
  97    @schemaLocation:string
  98    @baseType:string
  99 }
 100    ServiceOrderItem --> "0-1" ActionType : action
 101    ServiceOrderItem --> "0-1" StateType : state
 102    ServiceOrderItem --> "0-*" OrderItemRelationship : orderItemRelationship
 103    ServiceOrderItem --> "1-1" Service : service
 104    ServiceOrderItem --> "0-*" OrderMessage : orderItemMessage
 105
 106 class ServiceOrder {
 107    id:string
 108    href:string
 109    externalId:string
 110    priority:string
 111    description:string
 112    category:string
 113    orderDate:dateTime
 114    completionDateTime:dateTime
 115    requestedStartDate:dateTime
 116    requestedCompletionDate:dateTime
 117    expectedCompletionDate:dateTime
 118    startDate:dateTime
 119    @baseType:string
 120    @type:string
 121    @schemaLocation:string
 122 }
 123    ServiceOrder --> "0-1" StateType : state
 124    ServiceOrder --> "0-*" RelatedParty : relatedParty
 125    ServiceOrder --> "0-*" OrderRelationship : orderRelationship
 126    ServiceOrder --> "0-*" ServiceOrderItem : orderItem
 127    ServiceOrder --> "0-*" OrderMessage : orderMessage
 128
 129 class OrderRelationship {
 130    type:string
 131    id:string
 132    href:string
 133    @referredType:string
 134 }
 135
 136 class TargetServiceSchema {
 137    @type:string
 138    @schemaLocation:string
 139 }
 140
 141 class Value {
 142    serviceCharacteristicValue:string
 143 }
 144
 145 class CreateServiceOrderItem {
 146    id:string
 147 }
 148    CreateServiceOrderItem --> "0-1" ActionType : action
 149    CreateServiceOrderItem --> "0-*" OrderItemRelationship : orderItemRelationship
 150    CreateServiceOrderItem --> "1-1" Service : service
 151
 152 class CreateServiceOrder {
 153    externalId:string
 154    priority:string
 155    description:string
 156    category:string
 157    requestedStartDate:dateTime
 158    requestedCompletionDate:dateTime
 159 }
 160    CreateServiceOrder --> "0-*" RelatedParty : relatedParty
 161    CreateServiceOrder --> "0-*" OrderRelationship : orderRelationship
 162    CreateServiceOrder --> "0-*" CreateServiceOrderItem : orderItem
 163
 164 class ServiceOrderSummary {
 165    id:string
 166    href:string
 167    externalId:string
 168    orderDate:dateTime
 169    completionDateTime:dateTime
 170 }
 171    ServiceOrderSummary --> "0-1" StateType : state
 172
 173 class Notification {
 174    eventId:string
 175    eventDate:dateTime
 176 }
 177    Notification --> "1-1" EventType : eventType
 178    Notification --> "1-1" ServiceOrderSummaryWithItem : event
 179
 180 class ServiceOrderItemSummary {
 181    id:string
 182 }
 183    ServiceOrderItemSummary --> "0-1" ActionType : action
 184    ServiceOrderItemSummary --> "0-1" StateType : state
 185    ServiceOrderItemSummary --> "1-1" Service : service
 186
 187 class ServiceOrderSummaryWithItem {
 188    id:string
 189    href:string
 190    externalId:string
 191    orderDate:dateTime
 192    completionDateTime:dateTime
 193 }
 194    ServiceOrderSummaryWithItem --> "0-1" StateType : state
 195    ServiceOrderSummaryWithItem --> "0-*" ServiceOrderItemSummary : orderItem
 196
 197 class OrderMessage {
 198    code:string
 199    field:string
 200    messageInformation:string
 201    correctionRequired:boolean
 202 }
 203    OrderMessage --> "1-1" SeverityMessage : severity
 204
 205 @enduml