Resource Inventory Management - amkbcloud.com
Transcript of Resource Inventory Management - amkbcloud.com
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 1
AMKB Cloud
Resource Inventory Management
Business Service Specification
Author: Cliff C Faurer
Revision: 14.5.0
AMKB Cloud LLC
Denver, CO
USA
February 26, 2015
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 2
AMKB Cloud
TABLE OF CONTENTS
Table of Contents ............................................................................................................................................. 2
List of Figures ................................................................................................................................................... 5
Resource Inventory Management .................................................................................................................... 6
Resource Inventory Management Business Entities ....................................................................................... 7
Resource Base ................................................................................................................................................. 8
Business Entity – Association ................................................................................................................................... 8
Business Entity – Bundle ........................................................................................................................................... 8
Business Entity – CreateResourceBase ................................................................................................................... 8
Business Entity – PartialUpdateResourceBase ....................................................................................................... 9
Business Entity – ResourceBase ............................................................................................................................ 10
Business Entity – ResourceSpecificationRef ........................................................................................................ 11
Logical Resource ........................................................................................................................................... 12
Business Entity – LogicalResource ........................................................................................................................ 12
Physical Resource ......................................................................................................................................... 14
Business Entity – Physical Resource ..................................................................................................................... 14
Equipment ...................................................................................................................................................... 16
Business Entity – CreateEquipment ....................................................................................................................... 16
Business Entity – Equipment ................................................................................................................................... 18
Business Entity – PartialUpdateEquipment ........................................................................................................... 19
TopologicalLink .............................................................................................................................................. 22
Business Entity – CreateTopologicalLink .............................................................................................................. 22
Business Entity – PartialUpdateTopologicalLink .................................................................................................. 23
Business Entity – TopologicalLink ......................................................................................................................... 24
Termination Point Encapsulation ................................................................................................................... 26
Business Entity – CreateTpe .................................................................................................................................... 26
Business Entity – PartialUpdateTpe ....................................................................................................................... 27
Business Entity – SupportingEquipmentRef ......................................................................................................... 28
Business Entity – Tpe ............................................................................................................................................... 28
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 3
AMKB Cloud
Resource Common ........................................................................................................................................ 30
Business Entity – ASAPRef ..................................................................................................................................... 30
Business Entity – RelationshipRef .......................................................................................................................... 30
Business Entity – ResourceCharacteristic ............................................................................................................. 30
Common Business Entities ............................................................................................................................ 31
Business Entity – Alias ............................................................................................................................................. 31
Business Entity – ArrayUpdate................................................................................................................................ 31
Business Entity – BillingAccountRef ...................................................................................................................... 31
Business Entity – Characteristic ............................................................................................................................. 31
Business Entity – ContactMedium .......................................................................................................................... 31
Business Entity – CreateListener ............................................................................................................................ 32
Business Entity – Credential .................................................................................................................................... 32
Business Entity – Header ......................................................................................................................................... 32
Business Entity – Listener ....................................................................................................................................... 32
Business Entity – Medium ........................................................................................................................................ 32
Business Entity – Money .......................................................................................................................................... 33
Business Entity – Note ............................................................................................................................................. 33
Business Entity – PaymentMeanRef ....................................................................................................................... 33
Business Entity – Period .......................................................................................................................................... 33
Business Entity – PlaceRef ...................................................................................................................................... 34
Business Entity – RelatedPartyRef ......................................................................................................................... 34
Business Entity – TimePeriod .................................................................................................................................. 34
Notification Event ........................................................................................................................................... 35
ResourceInventory ......................................................................................................................................... 36
Business Entity – ResourceCreationNotification .................................................................................................. 36
Business Entity – ResourceDeletionNotification................................................................................................... 36
Business Entity – ResourceEvent ........................................................................................................................... 37
Business Entity – ResourceStatusChangeNotification ........................................................................................ 37
Business Entity – ResourceValueChangeNotification .......................................................................................... 37
Notification Common ...................................................................................................................................... 38
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 4
AMKB Cloud
Business Entity – Notification ................................................................................................................................. 38
State Machine ................................................................................................................................................ 39
Equipment ...................................................................................................................................................... 40
TopologicalLink .............................................................................................................................................. 41
TPE 42
Resource Inventory Management Business Services ................................................................................... 43
Business Service – Resource Inventory Equipment REST Service .................................................................... 43
Operation – postEquipment .................................................................................................................................. 43
Operation – getEquipment .................................................................................................................................... 43
Operation – getEquipments .................................................................................................................................. 43
Operation – putEquipment .................................................................................................................................... 43
Operation – patchEquipment ................................................................................................................................ 44
Business Service – Resource Inventory TopologicalLink REST Service ........................................................... 44
Operation – postTopologicalLink ......................................................................................................................... 44
Operation – getTopologicalLink ........................................................................................................................... 45
Operation – getTopologicalLinks ......................................................................................................................... 45
Operation – putTopologicalLink ........................................................................................................................... 45
Operation – patchTopologicalLink ....................................................................................................................... 45
Business Service – Resource Inventory TPE REST Service ................................................................................ 45
Operation – postTerminationPointEncapsulation .............................................................................................. 46
Operation – getTerminationPointEncapsulation ................................................................................................ 46
Operation – getTerminationPointEncapsulations .............................................................................................. 46
Operation – putTerminationPointEncapsulation ................................................................................................ 46
Operation – patchTerminationPointEncapsulation ............................................................................................ 46
Hub Business Service .................................................................................................................................... 48
Business Service – Hub REST Service ................................................................................................................... 48
Operation – registerListener ................................................................................................................................. 48
Operation – unregisterListener ............................................................................................................................ 48
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 5
AMKB Cloud
LIST OF FIGURES
Figure 1. Resource Inventory Management 6
Figure 2. Resource Base 8
Figure 3. Logical Resource 12
Figure 4. Physical Resource 14
Figure 5. Equipment 16
Figure 6. Topological Link 22
Figure 7. Termination Point Encapsulation 26
Figure 8. Resource Notification 36
Figure 9. EquipmentSM 40
Figure 10. TopologicalLinkSM 41
Figure 11. TPESM 42
Figure 12. Resource Inventory Equipment Business Service 43
Figure 13. Resource Topological Link Inventory Business Service 44
Figure 14. Resource Inventory TPE Business Service 46
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 6
AMKB Cloud
RESOURCE INVENTORY MANAGEMENT
Figure 1. Resource Inventory Management
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 7
AMKB Cloud
RESOURCE INVENTORY MANAGEMENT BUSINESS ENTITIES
The following document is intended to provide details of the REST API interface for Resource Inventory. The intent of
this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 8
AMKB Cloud
RESOURCE BASE
Resource base is an abstract resource that does not support any uniform creation or operation. The following is only
used for documentation purposes. The intent is to describe the common set of attributes shared by all concrete
resources (e.g. TPE, EQUIPMENT) in the inventory.
The type attribute must be implemented by all concrete resources and is a reserved attribute. Its value of is equal to
the name of the resource. For example a EQUIPMENT resource has the type value equal to "EQUIPMENT".
Figure 2. Resource Base
BUSINESS ENTITY – ASSOCIATION
Attributes
Name Type Multiplicity Description
href String 1
name String 1
role String 1
validFor TimePeriod 1
BUSINESS ENTITY – BUNDLE
Attributes
Name Type Multiplicity Description
href String 1
role String 0..1
BUSINESS ENTITY – CREATERESOURCEBASE
Resource base is an abstract resource that does not support any uniform creation or operation. The following is only
used for documentation purposes. The intent is to describe the common set of attributes shared by all concrete
resources (e.g. TPE, EQUIPMENT) in the inventory. The type attribute must be implemented by all concrete
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 9
AMKB Cloud
resources and is a reserved attribute. Its value of is equal to the name of the resource. For example a EQUIPMENT
resource has the type value equal to EQUIPMENT.
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
description String 0..1 free-text description of the resource.
extensionInfo RelationshipRef 1 A name/value pair list used to store any additional information needed. Combines both the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
isBundle Boolean 1 Is this a bundle of resources (Boolean).
name String 1 A string used to give a name to the resource.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
type String 1 Name of the resource type.
Business Rules
Name Severity Specification Message
mandatory attributes [name type isBundle]
BUSINESS ENTITY – PARTIALUPDATERESOURCEBASE
Resource base is an abstract resource that does not support any uniform creation or operation. The following is only
used for documentation purposes. The intent is to describe the common set of attributes shared by all concrete
resources (e.g. TPE, EQUIPMENT) in the inventory. The type attribute must be implemented by all concrete
resources and is a reserved attribute. Its value of is equal to the name of the resource. For example a EQUIPMENT
resource has the type value equal to EQUIPMENT.
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
description String 0..1 free-text description of the resource.
extensionInfo RelationshipRef 1 A name/value pair list used to store any
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 10
AMKB Cloud
additional information needed. Combines both the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
isBundle Boolean 1 Is this a bundle of resources (Boolean).
name String 1 A string used to give a name to the resource.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
status String 0..1 The life cycle state of the resource - in study, in design, in test, rejected, active, launched, retired, obsolete.
type String 1 Name of the resource type.
Business Rules
Name Severity Specification Message
can be updated [description status - in study, in design, in test, rejected, active, launched, retired, obsolete alias bundle association extensionInfo]
mandatory attributes []
BUSINESS ENTITY – RESOURCEBASE
Resource base is an abstract resource that does not support any uniform creation or operation. The following is only
used for documentation purposes. The intent is to describe the common set of attributes shared by all concrete
resources (e.g. TPE, EQUIPMENT) in the inventory. The type attribute must be implemented by all concrete
resources and is a reserved attribute. Its value of is equal to the name of the resource. For example a EQUIPMENT
resource has the type value equal to EQUIPMENT.
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
description String 0..1 free-text description of the resource.
extensionInfo RelationshipRef 1 A name/value pair list used to store any additional information needed. Combines both the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 11
AMKB Cloud
href String 1 The URI for the object itself.
id String 1 Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.
isBundle Boolean 1 Is this a bundle of resources (Boolean).
lastModified DateTime 1
name String 1 A string used to give a name to the resource.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
status String 0..1 The life cycle state of the resource - in study, in design, in test, rejected, active, launched, retired, obsolete.
type String 1 Name of the resource type.
BUSINESS ENTITY – RESOURCESPECIFICATIONREF
Attributes
Name Type Multiplicity Description
href String 1
role String 0..1
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 12
AMKB Cloud
LOGICAL RESOURCE
Figure 3. Logical Resource
BUSINESS ENTITY – LOGICALRESOURCE
Logic resource is an abstract resource that does not support any uniform creation or operation. At this time it does not
contain any attributes but exists to distinguish the different types of resources. The following is only used for
documentation purposes. The intent is to describe the common set of attributes shared by all concrete logical
resources (e.g. FRE) in the inventory.
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
description String 0..1 free-text description of the resource.
extensionInfo RelationshipRef 1 A name/value pair list used to store any additional information needed. Combines both the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
href String 1 The URI for the object itself.
id String 1 Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 13
AMKB Cloud
isBundle Boolean 1 Is this a bundle of resources (Boolean).
lastModified DateTime 1
name String 1 A string used to give a name to the resource.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
status String 0..1 The life cycle state of the resource - in study, in design, in test, rejected, active, launched, retired, obsolete.
type String 1 Name of the resource type.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 14
AMKB Cloud
PHYSICAL RESOURCE
Figure 4. Physical Resource
BUSINESS ENTITY – PHYSICAL RESOURCE
Physical resource is an abstract resource that does not support any uniform creation or operation. The following is
only used for documentation purposes. The intent is to describe the common set of attributes shared by all concrete
physical resources (e.g. EQUIPMENT) in the inventory.
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
description String 0..1 free-text description of the resource.
extensionInfo RelationshipRef 1 A name/value pair list used to store any additional information needed. Combines both the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
href String 1 The URI for the object itself.
id String 1 Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.
isBundle Boolean 1 Is this a bundle of resources (Boolean).
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 15
AMKB Cloud
lastModified DateTime 1
location String 0..1 A textual description of the location of the equipment. Can be used to store a association to a location in systems that support location management.
manufactureDate DateTime 0..1 The date/time of manufacture.
manufacturer String 0..1 The name of the manufacturer.
name String 1 A string used to give a name to the resource.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
status String 0..1 The life cycle state of the resource - in study, in design, in test, rejected, active, launched, retired, obsolete.
type String 1 Name of the resource type.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 16
AMKB Cloud
EQUIPMENT
This operation is used to register a Resource Inventory listener.
Figure 5. Equipment
BUSINESS ENTITY – CREATEEQUIPMENT
Equipment is an example of a physical resource.
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
asap ASAPRef 0..1
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
containedEquipment ResourceBase 0..*
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 17
AMKB Cloud
description String 0..1 free-text description of the resource.
expectedEquipmentType String 0..1 This attribute identifies the type of the expected resource. For example, Fan or STM16 for the Equipment class and Line EQUIPMENT for the Equipment Holder class. This is an empty string if there is no expected equipment.
extensionInfo RelationshipRef 1 A name/value pair list used to store any additional information needed. Combines both the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
installedEquipmentType String 0..1 This attribute identifies the type of the installed resource. For example, Fan or STM16 for the Equipment class and Line EQUIPMENT for the Equipment Holder class. The installed equipment type is invariant for the lifetime of the hardware. This is an empty string if there is no expected equipment.
installedPartNumber String 0..1 This attribute identifies the vendor's resource Part Number (PN) of the installed equipment. If PN is not available empty string shall be used. If the part and serial number are both non-null then the part+serial number together shall be unique.
installedSerialNumber String 0..1 This attribute contains the vendor's serial number of the installed equipment. Unique, if no default is provided. At least one serial number has to be provided.
installedVersion String 0..1 This attribute identifies the vendor's resource version of the installed equipment.
isBundle Boolean 1 Is this a bundle of resources (Boolean).
isReportingAlarms Boolean 0..1 This attribute provides an indication of whether alarm reporting for this Equipment is enabled (true) or disabled (false).
name String 1 A string used to give a name to the resource.
protectionRole String 0..1 This attribute defines the protection role that this equipment plays. In case the equipment is not protected, the value NOT_APPLICABLE shall be used.
protectionSchemeState String 0..1 This attribute identifies the individual lock of this equipment. In case the equipment is not protected, the value UNKNOWN shall also be used.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
type String 1 Name of the resource type.
Business Rules
Name Severity Specification Message
mandatory attributes [name type
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 18
AMKB Cloud
isBundle]
BUSINESS ENTITY – EQUIPMENT
Equipment is an example of a physical resource.
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
asap ASAPRef 0..1
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
containedEquipment ResourceBase 0..*
description String 0..1 free-text description of the resource.
expectedEquipmentType String 0..1 This attribute identifies the type of the expected resource. For example, Fan or STM16 for the Equipment class and Line EQUIPMENT for the Equipment Holder class. This is an empty string if there is no expected equipment.
extensionInfo RelationshipRef 1 A name/value pair list used to store any additional information needed. Combines both the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
href String 1 The URI for the object itself.
id String 1 Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.
installedEquipmentType String 0..1 This attribute identifies the type of the installed resource. For example, Fan or STM16 for the Equipment class and Line EQUIPMENT for the Equipment Holder class. The installed equipment type is invariant for the lifetime of the hardware. This is an empty string if there is no expected equipment.
installedPartNumber String 0..1 This attribute identifies the vendor's resource Part Number (PN) of the installed equipment. If PN is not available empty string shall be used. If the part and serial number are both non-null then the part+serial number together shall be unique.
installedSerialNumber String 0..1 This attribute contains the vendor's serial number of the installed equipment. Unique, if no default is provided. At least one serial number has to be provided.
installedVersion String 0..1 This attribute identifies the vendor's resource version of the installed equipment.
isBundle Boolean 1 Is this a bundle of resources (Boolean).
isReportingAlarms Boolean 0..1 This attribute provides an indication of whether alarm reporting for this Equipment is enabled (true) or disabled (false).
lastModified DateTime 1
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 19
AMKB Cloud
location String 0..1 A textual description of the location of the equipment. Can be used to store a association to a location in systems that support location management.
manufactureDate DateTime 0..1 The date/time of manufacture.
manufacturer String 0..1 The name of the manufacturer.
name String 1 A string used to give a name to the resource.
protectionRole String 0..1 This attribute defines the protection role that this equipment plays. In case the equipment is not protected, the value NOT_APPLICABLE shall be used.
protectionSchemeState String 0..1 This attribute identifies the individual lock of this equipment. In case the equipment is not protected, the value UNKNOWN shall also be used.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
status String 0..1 The life cycle state of the resource - in study, in design, in test, rejected, active, launched, retired, obsolete.
type String 1 Name of the resource type.
BUSINESS ENTITY – PARTIALUPDATEEQUIPMENT
Equipment is an example of a physical resource.
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
asap ASAPRef 0..1
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
containedEquipment ResourceBase 0..*
description String 0..1 free-text description of the resource.
expectedEquipmentType String 0..1 This attribute identifies the type of the expected resource. For example, Fan or STM16 for the Equipment class and Line EQUIPMENT for the Equipment Holder class. This is an empty string if there is no expected equipment.
extensionInfo RelationshipRef 1 A name/value pair list used to store any additional information needed. Combines both the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
installedEquipmentType String 0..1 This attribute identifies the type of the installed resource. For example, Fan or STM16 for the Equipment class and Line EQUIPMENT for the
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 20
AMKB Cloud
Equipment Holder class. The installed equipment type is invariant for the lifetime of the hardware. This is an empty string if there is no expected equipment.
installedPartNumber String 0..1 This attribute identifies the vendor's resource Part Number (PN) of the installed equipment. If PN is not available empty string shall be used. If the part and serial number are both non-null then the part+serial number together shall be unique.
installedSerialNumber String 0..1 This attribute contains the vendor's serial number of the installed equipment. Unique, if no default is provided. At least one serial number has to be provided.
installedVersion String 0..1 This attribute identifies the vendor's resource version of the installed equipment.
isBundle Boolean 1 Is this a bundle of resources (Boolean).
isReportingAlarms Boolean 0..1 This attribute provides an indication of whether alarm reporting for this Equipment is enabled (true) or disabled (false).
name String 1 A string used to give a name to the resource.
protectionRole String 0..1 This attribute defines the protection role that this equipment plays. In case the equipment is not protected, the value NOT_APPLICABLE shall be used.
protectionSchemeState String 0..1 This attribute identifies the individual lock of this equipment. In case the equipment is not protected, the value UNKNOWN shall also be used.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
status String 0..1 The life cycle state of the resource - in study, in design, in test, rejected, active, launched, retired, obsolete.
type String 1 Name of the resource type.
Business Rules
Name Severity Specification Message
can be updated [description status - in study, in design, in test, rejected, active, launched, retired, obsolete installedVersion installedSerialNumber installedPartNumber isReportingAlarms protectionRole protectionSchemeState installedEquipmentType expectedEquipmentType alias bundle association
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 21
AMKB Cloud
extensionInfo asap]
mandatory attributes []
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 22
AMKB Cloud
TOPOLOGICALLINK
Figure 6. Topological Link
BUSINESS ENTITY – CREATETOPOLOGICALLINK
Topological Link is an example of a logical resource.
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
description String 0..1 free-text description of the resource.
directionality String
extensionInfo RelationshipRef 1 A name/value pair list used to store any additional information needed. Combines both the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 23
AMKB Cloud
exist.
isAlarmReporting Boolean
isBundle Boolean 1 Is this a bundle of resources (Boolean).
layerProtocolName String
name String 1 A string used to give a name to the resource.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
supportingEquipment ResourceBase 0..*
type String 1 Name of the resource type.
Business Rules
Name Severity Specification Message
mandatory attributes [name type isBundle]
BUSINESS ENTITY – PARTIALUPDATETOPOLOGICALLINK
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
description String 0..1 free-text description of the resource.
directionality String
extensionInfo RelationshipRef 1 A name/value pair list used to store any additional information needed. Combines both the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
isAlarmReporting Boolean
isBundle Boolean 1 Is this a bundle of resources (Boolean).
layerProtocolName String
name String 1 A string used to give a name to the resource.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
status String 0..1 The life cycle state of the resource - in study, in design, in test, rejected, active, launched, retired, obsolete.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 24
AMKB Cloud
supportingEquipment ResourceBase 0..*
type String 1 Name of the resource type.
Business Rules
Name Severity Specification Message
can be updated [description status - in study, in design, in test, rejected, active, launched, retired, obsolete alias bundle association extensionInfo]
mandatory attributes []
BUSINESS ENTITY – TOPOLOGICALLINK
Topological Link is an example of a logical resource.
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
description String 0..1 free-text description of the resource.
directionality String
extensionInfo RelationshipRef 1 A name/value pair list used to store any additional information needed. Combines both the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
href String 1 The URI for the object itself.
id String 1 Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.
isAlarmReporting Boolean
isBundle Boolean 1 Is this a bundle of resources (Boolean).
lastModified DateTime 1
layerProtocolName String
name String 1 A string used to give a name to the resource.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
status String 0..1 The life cycle state of the resource - in study, in design, in test, rejected, active, launched, retired, obsolete.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 25
AMKB Cloud
supportingEquipment ResourceBase 0..*
type String 1 Name of the resource type.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 26
AMKB Cloud
TERMINATION POINT ENCAPSULATION
Figure 7. Termination Point Encapsulation
BUSINESS ENTITY – CREATETPE
The TPE is an example of a logical resource.
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
asap ASAPRef 1 Reference to the assigned AlarmsSeverityAssignmentProfile.
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
description String 0..1 free-text description of the resource.
egressTmdState String 1 This attribute contains the state of consistency between a TPE and its associated egress TransmissionDescriptor.
extensionInfo RelationshipRef 1 A name/value pair list used to store any additional information needed. Combines both the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 27
AMKB Cloud
equivalent to a MAP data structure where only one entry for any given value of name can exist.
ingressTmdState String 1 This attribute contains the state of consistency between a TPE and its associated ingress TransmissionDescriptor.
isBundle Boolean 1 Is this a bundle of resources (Boolean).
isEquipmentProtected Boolean 1 This attribute indicates whether or not the TPE is supported by a protected equipment.
name String 1 A string used to give a name to the resource.
port String This attribute contains the name of the port associated with the TPE.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
supportingEquipment SupportingEquipmentRef
0..* This attribute contains references to the equipment that supports the TPE.
tpeType String 1 This attribute represents the name of the specification that describes the construction of the TPE emphasising for example the access to the TPE and whether it is associated with a physical port directly or not. Amongst other things this attribute would identify whether the TPE is a PTP, CTP or FTP.
type String 1 Name of the resource type.
Business Rules
Name Severity Specification Message
mandatory attributes [name type isBundle]
BUSINESS ENTITY – PARTIALUPDATETPE
The TPE is an example of a logical resource.
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
asap ASAPRef 1 Reference to the assigned AlarmsSeverityAssignmentProfile.
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
description String 0..1 free-text description of the resource.
egressTmdState String 1 This attribute contains the state of consistency between a TPE and its associated egress TransmissionDescriptor.
extensionInfo RelationshipRef 1 A name/value pair list used to store any additional information needed. Combines both
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 28
AMKB Cloud
the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
ingressTmdState String 1 This attribute contains the state of consistency between a TPE and its associated ingress TransmissionDescriptor.
isBundle Boolean 1 Is this a bundle of resources (Boolean).
isEquipmentProtected Boolean 1 This attribute indicates whether or not the TPE is supported by a protected equipment.
name String 1 A string used to give a name to the resource.
port String This attribute contains the name of the port associated with the TPE.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
status String 0..1 The life cycle state of the resource - in study, in design, in test, rejected, active, launched, retired, obsolete.
supportingEquipment SupportingEquipmentRef
0..* This attribute contains references to the equipment that supports the TPE.
tpeType String 1 This attribute represents the name of the specification that describes the construction of the TPE emphasising for example the access to the TPE and whether it is associated with a physical port directly or not. Amongst other things this attribute would identify whether the TPE is a PTP, CTP or FTP.
type String 1 Name of the resource type.
Business Rules
Name Severity Specification Message
can be updated [description status - in study, in design, in test, rejected, active, launched, retired, obsolete alias bundle association extensionInfo]
mandatory attributes []
BUSINESS ENTITY – SUPPORTINGEQUIPMENTREF
Attributes
Name Type Multiplicity Description
href String 1
BUSINESS ENTITY – TPE
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 29
AMKB Cloud
The TPE is an example of a logical resource.
Attributes
Name Type Multiplicity Description
alias Alias 0..* A list of named aliases. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
asap ASAPRef 1 Reference to the assigned AlarmsSeverityAssignmentProfile.
association Association 0..* List of associations to related entities.
bundle Bundle 0..* List of bundled resources.
description String 0..1 free-text description of the resource.
egressTmdState String 1 This attribute contains the state of consistency between a TPE and its associated egress TransmissionDescriptor.
extensionInfo RelationshipRef 1 A name/value pair list used to store any additional information needed. Combines both the SID additionalInfo and MTOSI vendorExtensions attributes. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
href String 1 The URI for the object itself.
id String 1 Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.
ingressTmdState String 1 This attribute contains the state of consistency between a TPE and its associated ingress TransmissionDescriptor.
isBundle Boolean 1 Is this a bundle of resources (Boolean).
isEquipmentProtected Boolean 1 This attribute indicates whether or not the TPE is supported by a protected equipment.
lastModified DateTime 1
name String 1 A string used to give a name to the resource.
port String This attribute contains the name of the port associated with the TPE.
resourceCharacteristic ResourceCharacteristic
0..* A name/value pair list used to store instance specific values of attributes found in association resource specifications. The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
resourceSpecification ResourceSpecificationRef
0..1 List of associated resource specifications.
status String 0..1 The life cycle state of the resource - in study, in design, in test, rejected, active, launched, retired, obsolete.
supportingEquipment SupportingEquipmentRef
0..* This attribute contains references to the equipment that supports the TPE.
tpeType String 1 This attribute represents the name of the specification that describes the construction of the TPE emphasising for example the access to the TPE and whether it is associated with a physical port directly or not. Amongst other things this attribute would identify whether the TPE is a PTP, CTP or FTP.
type String 1 Name of the resource type.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 30
AMKB Cloud
RESOURCE COMMON
BUSINESS ENTITY – ASAPREF
Attributes
Name Type Multiplicity Description
href String 1
BUSINESS ENTITY – RELATIONSHIPREF
Attributes
Name Type Multiplicity Description
href String 1
role String 1
BUSINESS ENTITY – RESOURCECHARACTERISTIC
A name/value pair list used to store instance specific values of attributes found in association resource specifications.
The behavior is equivalent to a MAP data structure where only one entry for any given value of name can exist.
Attributes
Name Type Multiplicity Description
name String 1
value String 1
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 31
AMKB Cloud
COMMON BUSINESS ENTITIES
BUSINESS ENTITY – ALIAS
Attributes
Name Type Multiplicity Description
type String
value String
BUSINESS ENTITY – ARRAYUPDATE
Used to partially update an array
Attributes
Name Type Multiplicity Description
op String Operation to be performed on the array - test, remove, add, replace, move, copy
path String The reference to the array to be modified
value String
BUSINESS ENTITY – BILLINGACCOUNTREF
BillingAccount to use to bill the ordered products.
Attributes
Name Type Multiplicity Description
href String 1 Reference of the billing account.
BUSINESS ENTITY – CHARACTERISTIC
Describes the characteristics of the individual or the organization such as individual hobbies, center of interests.
Attributes
Name Type Multiplicity Description
name String 1 Name of the characteristic.
value String 0..1 Value of the characteristic.
BUSINESS ENTITY – CONTACTMEDIUM
Describes the contact mediums that could be used to contact the customer (Email, TelephoneNumber,
PostalAddress).
Attributes
Name Type Multiplicity Description
isPreferred Boolean 0..1 If true, indicates that is the preferred contact medium.
medium Medium 0..1 Describes the contact medium that can be
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 32
AMKB Cloud
used to contact the customer.
type String 1 Email address, telephone number, postal address, etc.
validFor TimePeriod 0..1 The time period that the contact medium is valid for.
BUSINESS ENTITY – CREATELISTENER
Attributes
Name Type Multiplicity Description
callback String Callback address of the listener
query String
BUSINESS ENTITY – CREDENTIAL
Attributes
Name Type Multiplicity Description
login String
password String
updateType String
BUSINESS ENTITY – HEADER
Attributes
Name Type Multiplicity Description
key String URL Parameter Key e.g., Content-Type
value String Value e.g., application/json, application/xml
BUSINESS ENTITY – LISTENER
Attributes
Name Type Multiplicity Description
callback String Callback address of the listener
href String 1 Reference to the listener
id String 1
query String
BUSINESS ENTITY – MEDIUM
Describes the contact medium that can be used to contact the customer.
Attributes
Name Type Multiplicity Description
city String 0..1
country String 0..1
emailAddress String 0..1 Full e-mail address in standard format (e.g., [email protected])
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 33
AMKB Cloud
number String 0..1 Phone number
postcode String 0..1 Postcode
stateOrProvince String 0..1 State or province
street1 String 0..1 Describes the street
street2 String 0..1 Complementary street description
type String 0..1 Type of medium (fax, mobile phone...)
BUSINESS ENTITY – MONEY
A base / value business entity used to represent money
Attributes
Name Type Multiplicity Description
amount Float 1 A positive floating point number.
currencyCode String 1 Currency. Notes: refer to [ISO 4217]
digits Integer 0..1 Number of digits to the right of the decimal point
BUSINESS ENTITY – NOTE
Extra-information about an entity (e.g. useful to add extra delivery information that could be useful for a human
process : a digicode access to a building, ...).
Attributes
Name Type Multiplicity Description
author String 0..1 Author of the note
date DateTime 0..1 Date of the note
text String 1 Text of the note
BUSINESS ENTITY – PAYMENTMEANREF
Attributes
Name Type Multiplicity Description
href String 1 Reference of the payment means
name String 0..1 Name of the payment means
BUSINESS ENTITY – PERIOD
defines the period of a recurring charge
Attributes
Name Type Multiplicity Description
endPeriod DateTime 0..1 End date of the period
startPeriod DateTime 1 Start date of the period
Business Rules
Name Severity Specification Message
StartPeriod Before EndPeriod
error [startPeriod.before(endPeriod) or startPeriod = endPeriod]
The start period must be on or before the end period.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 34
AMKB Cloud
BUSINESS ENTITY – PLACEREF
Used to defined a place useful for the entity (for example a delivery geographical place).
Attributes
Name Type Multiplicity Description
href String 1 Reference of a place (for instance in Google map).
role String 1 Role of the place (for instance delivery geographical place).
BUSINESS ENTITY – RELATEDPARTYREF
Defines party or partyRole linked to a specific entity. Used to represent an association between a resource and a party
or role object playing a role regarding that object.
Attributes
Name Type Multiplicity Description
alias Alias 0..*
href String 1 Reference to the related party.
name String 0..1 Name of the related party.
role String 1 Role of the related party.
status String 0..1 The status of the relationship between the party and the related entity.
validFor TimePeriod 0..1 The period for which the related party is valid.
BUSINESS ENTITY – TIMEPERIOD
Attributes
Name Type Multiplicity Description
endDateTime DateTime 0..1
startDateTime DateTime 1
Business Rules
Name Severity Specification Message
Start DateTime Before End DateTime
error [startDateTime.before(endDateTime) or startDateTime = endDateTime]
The start period must be on or before the end period.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 35
AMKB Cloud
NOTIFICATION EVENT
Refer to Common Management Spec for details on how to Register and Unregister a Listener.
The notification events supported by Resource Inventory Management are:
o Resource create
o Resource value change
o Resource state change
o Resource delete
The Event is published to the registered listener
REST Example:
POST client/listener
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 36
AMKB Cloud
RESOURCEINVENTORY
Figure 8. Resource Notification
BUSINESS ENTITY – RESOURCECREATIONNOTIFICATION
Used to notify that a resource was created in the inventory.
Attributes
Name Type Multiplicity Description
event ResourceEvent 1
eventId String 0..1 Unique identifier of the event
eventTime DateTime 1
eventType String 1
BUSINESS ENTITY – RESOURCEDELETIONNOTIFICATION
Used to notify that a resource was removed from the inventory.
Attributes
Name Type Multiplicity Description
event ResourceEvent 1
eventId String 0..1 Unique identifier of the event
eventTime DateTime 1
eventType String 1
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 37
AMKB Cloud
BUSINESS ENTITY – RESOURCEEVENT
Attributes
Name Type Multiplicity Description
equipment Equipment 1
topologicalLink TopologicalLink 1
tpe Tpe 1
BUSINESS ENTITY – RESOURCESTATUSCHANGENOTIFICATION
Used to notify that a resource state has changed in the inventory.
Attributes
Name Type Multiplicity Description
event ResourceEvent 1
eventId String 0..1 Unique identifier of the event
eventTime DateTime 1
eventType String 1
BUSINESS ENTITY – RESOURCEVALUECHANGENOTIFICATION
Used to notify that a resource value was modified in the inventory.
Attributes
Name Type Multiplicity Description
event ResourceEvent 1
eventId String 0..1 Unique identifier of the event
eventTime DateTime 1
eventType String 1
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 38
AMKB Cloud
NOTIFICATION COMMON
BUSINESS ENTITY – NOTIFICATION
Attributes
Name Type Multiplicity Description
eventId String 0..1 Unique identifier of the event
eventTime DateTime 1
eventType String 1
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 39
AMKB Cloud
STATE MACHINE
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 40
AMKB Cloud
EQUIPMENT
EquipmentSM
Equipment is an example of a physical resource.
Figure 9. EquipmentSM
Name Description
Active Then either the test is OK and then its status is changed to “Active”. When a Equipment element is in a “Active” status it means it has been validated and tested, but it is still not available for customers.
In Design When the conception of the Equipment element is accepted its status is changed to “In Design”.
In Study When the macro conception of a Equipment element is started the first status of the later is “In Study”.
In Test If the design is approved its status is changed to “In Test”.
Launched When the beginning of marketing is reached, its status is changed to “Launched”. At this moment customers can buy it.
Obsolete When no more customer holds the Equipment element, its status is changed to “Obsolete” meaning it can be removed from the Equipment.
Rejected Test is not OK and its status is changed to “Rejected”. The Rejected status is a final status.
Retired If the Equipment element is not launched, its status is changed to “Retired”. The same status is achieved when a Equipment element reaches the end of marketing. The “Retired” status means it can not be sold to any new customers, but previous customers can still have it.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 41
AMKB Cloud
TOPOLOGICALLINK
TopologicalLinkSM
Topological Link is an example of a logical resource.
Figure 10.TopologicalLinkSM
Name Description
Active Then either the test is OK and then its status is changed to “Active”. When a TopologicalLink element is in a “Active” status it means it has been validated and tested, but it is still not available for customers.
In Design When the conception of the TopologicalLink element is accepted its status is changed to “In Design”.
In Study When the macro conception of a TopologicalLink element is started the first status of the later is “In Study”.
In Test If the design is approved its status is changed to “In Test”.
Launched When the beginning of marketing is reached, its status is changed to “Launched”. At this moment customers can buy it.
Obsolete When no more customer holds the TopologicalLink element, its status is changed to “Obsolete” meaning it can be removed from the TopologicalLink.
Rejected Test is not OK and its status is changed to “Rejected”. The Rejected status is a final status.
Retired If the TopologicalLink element is not launched, its status is changed to “Retired”. The same status is achieved when a TopologicalLink element reaches the end of marketing. The “Retired” status means it can not be sold to any new customers, but previous customers can still have it.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 42
AMKB Cloud
TPE
TPESM
The TPE is an example of a logical resource.
Figure 11.TPESM
Name Description
Active Then either the test is OK and then its status is changed to “Active”. When a TPE element is in a “Active” status it means it has been validated and tested, but it is still not available for customers.
In Design When the conception of the TPE element is accepted its status is changed to “In Design”.
In Study When the macro conception of a TPE element is started the first status of the later is “In Study”.
In Test If the design is approved its status is changed to “In Test”.
Launched When the beginning of marketing is reached, its status is changed to “Launched”. At this moment customers can buy it.
Obsolete When no more customer holds the TPE element, its status is changed to “Obsolete” meaning it can be removed from the TPE.
Rejected Test is not OK and its status is changed to “Rejected”. The Rejected status is a final status.
Retired If the TPE element is not launched, its status is changed to “Retired”. The same status is achieved when a TPE element reaches the end of marketing. The “Retired” status means it can not be sold to any new customers, but previous customers can still have it.
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 43
AMKB Cloud
RESOURCE INVENTORY MANAGEMENT BUSINESS SERVICES
BUSINESS SERVICE – RESOURCE INVENTORY EQUIPMENT REST SERVICE
Figure 12.Resource Inventory Equipment Business Service
OPERATION – POSTEQUIPMENT
Description
This operation is used to create an Equipment.
Business Rules
Name Severity Specification Message
mandatory attributes [name type isBundle]
OPERATION – GETEQUIPMENT
Description
This operation is used to retrieve an Equipment.
Business Rules
Name Severity Specification Message
mandatory attributes [id]
OPERATION – GETEQUIPMENTS
Description
This operation is used to retrieve a collection of Equipments.
OPERATION – PUTEQUIPMENT
Description
This operation is used to completely update the representation of an Equipment.
Business Rules
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 44
AMKB Cloud
Name Severity Specification Message
mandatory attributes [id]
OPERATION – PATCHEQUIPMENT
Description
This operation is used to partially update the representation of an Equipment.
Business Rules
Name Severity Specification Message
can be updated [description status - in study, in design, in test, rejected, active, launched, retired, obsolete installedVersion installedSerialNumber installedPartNumber isReportingAlarms protectionRole protectionSchemeState installedEquipmentType expectedEquipmentType alias bundle association extensionInfo asap]
mandatory attributes []
BUSINESS SERVICE – RESOURCE INVENTORY TOPOLOGICALLINK REST
SERVICE
Figure 13.Resource Topological Link Inventory Business Service
OPERATION – POSTTOPOLOGICALLINK
Description
This operation is used to create a TopologicalLink.
Business Rules
Name Severity Specification Message
mandatory attributes [name type
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 45
AMKB Cloud
isBundle]
OPERATION – GETTOPOLOGICALLINK
Description
This operation is used to retrieve a TopologicalLink.
Business Rules
Name Severity Specification Message
mandatory attributes [id]
OPERATION – GETTOPOLOGICALLINKS
Description
This operation is used to retrieve a collection of TopologicalLinks.
OPERATION – PUTTOPOLOGICALLINK
Description
This operation is used to completely update a TopologicalLink.
Business Rules
Name Severity Specification Message
mandatory attributes [id]
OPERATION – PATCHTOPOLOGICALLINK
Description
This operation is used to partially update a TopologicalLink.
Business Rules
Name Severity Specification Message
can be updated [description status - in study, in design, in test, rejected, active, launched, retired, obsolete alias bundle association extensionInfo]
mandatory attributes []
BUSINESS SERVICE – RESOURCE INVENTORY TPE REST SERVICE
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 46
AMKB Cloud
Figure 14.Resource Inventory TPE Business Service
OPERATION – POSTTERMINATIONPOINTENCAPSULATION
Description
This operation is used to create a TerminationPointEncapsulation.
Business Rules
Name Severity Specification Message
mandatory attributes [name type isBundle]
OPERATION – GETTERMINATIONPOINTENCAPSULATION
Description
This operation is used to retrieve a TerminationPointEncapsulation.
Business Rules
Name Severity Specification Message
mandatory attributes [id]
OPERATION – GETTERMINATIONPOINTENCAPSULATIONS
Description
This operation is used to retrieve a collection of TerminationPointEncapsulations.
OPERATION – PUTTERMINATIONPOINTENCAPSULATION
Description
This operation is used to completely update a TerminationPointEncapsulation.
Business Rules
Name Severity Specification Message
mandatory attributes [id]
OPERATION – PATCHTERMINATIONPOINTENCAPSULATION
Description
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 47
AMKB Cloud
This operation is used to partially update a TerminationPointEncapsulation.
Business Rules
Name Severity Specification Message
can be updated [description status - in study, in design, in test, rejected, active, launched, retired, obsolete alias bundle association extensionInfo]
mandatory attributes []
Business Service Specification
AMKB Cloud Confidential. All Rights Reserved. Page 48
AMKB Cloud
HUB BUSINESS SERVICE
The notification events supported by Resource Inventory Management are:
o Resource create
o Resource value change
o Resource state change
o Resource delete
The Event is published to the registered listener
REST Example:
POST client/listener
BUSINESS SERVICE – HUB REST SERVICE
OPERATION – REGISTERLISTENER
Description
This operation is used to register a Resource Inventory listener.
Business Rules
Name Severity Specification Message
mandatory attributes [description severity type]
OPERATION – UNREGISTERLISTENER
Description
This operation is used to unregister a Resource Inventory listener.
Business Rules
Name Severity Specification Message
mandatory attributes [description severity type]