Cisco Cisco Security Manager 3.3 Guia De Especificaciones
Cisco Security Manager 4.4 API Specification (Version 1.1)
OL- 29074-01
Page 20
2
Common Service API
This section describes the common methods and common object model for all services on the CSM API.
2.1 Object Model
The following object classes are used throughout the API specification.
2.1.1 Object Identifier
The Object Identifier is a global unique identifier for an object. The Object Identifier is a 128-bit value based on
RFC4122.
RFC4122.
Figure 2: ObjectIdentifier & ObjectIdentifierList XML Schema
2.1.2 Base Object
The common class for all objects in the system and all object classes inherit from this class. It has the following
attributes:
attributes:
Attribute
Type
Comment
gid
Object
Identifier
Identifier
Unique object identifier for an object and is immutable for the
object lifetime
object lifetime
lastUpdateTime
TimeStamp
Indicates the update time for an object either created or updated.
name
String
An optional display name for the object.
parentGID
Object
Identifier
Identifier
An optional parent object identifier that identifies an object’s parent
instance.
instance.
updatedByUser
String
Username of the User who updated the Object.
lastCommitTime
dateTime
Last Updated time for the object
ticketId
String
Ticket ID of the ticket as part of which the Object has been updated.
<xs:simpleType
name
=
"ObjectIdentifier"
>
<xs:restriction
base
=
"xs:string"
>
<xs:pattern
value
=
"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
>
</xs:pattern>
</xs:restriction>
</xs:simpleType>
<xs:complexType
name
=
"ObjectIdentifierList"
>
<xs:sequence>
<xs:element name="gid" type="ObjectIdentifier" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>