Cisco Cisco Security Manager 4.11 User Guide

 

 

 

  

This section describes the common methods and common object model for all services on the CSM API. 

The following object classes are used throughout the API specification. 

The Object Identifier is a global unique identifier for an object. The Object Identifier is a 128-bit value based on 
RFC4122. 

 

The common class for all objects in the system and all object classes inherit from this class. It has the following 
attributes: 

 

Attribute 

Type 

Comment 

gid 

Object 
Identifier 

Unique object identifier for an object and is immutable for the 
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 

An optional parent object identifier that identifies an object’s parent 
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. 

This will not be available if Ticketing is not enabled. 

activityName 

String 

Activity Name of the Activity as part of which the Object has been 
updated. This is applicable if the CSM is in WorkFlow mode. 

<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>