getObjectTypeInformation

Web Services Methods › Miscellaneous Methods › getObjectTypeInformation

getObjectTypeInformation

The following parameters apply to the getObjectTypeInformation method:

Parameter	Type	Description
SID	Integer	Identifies the session retrieved from logging in.
factory	String	Identifies the object type (known as ‘factory’) to query. This is the majic name of the object, for example: “cr” = Request

Parameter

Type

Description

SID

Integer

Identifies the session retrieved from logging in.

factory

String

Identifies the object type (known as ‘factory’) to query. This is the majic name of the object, for example:

“cr” = Request

Description

A list of all attribute names for a given object type, along with type information for each attribute. Information returned for the attribute’s type includes the Integer, String, Date, Pointer, List, and so on, if the attribute is required for back-storing its storage space requirements (if appropriate).

Callers should cache the type information requested per object type to avoid multiple, redundant (and expensive) calls. The attribute information can change only after modifications are performed on the CA SDM server and the service is recycled.

Returns

The following:

XML Element	Type	Description
<UDSObject>	N/A	Indicates the root node.
<Attributes>	Sequence	Indicates zero or more elements for each attribute.
<attrName DataType=”dataType” Size=”storageSize” Required=”Boolean” Factory=”factoryName”>	Empty Element	Indicates an element with a name matching an object attribute name. The element has several attributes: DataType Signifies the integer representation of the data type. Size Represents the maximum size needed to store this attribute in a string. Required Represents the flag status of True if this attribute must be set for the object to back store. Factory Represents the Type name of the object if the attribute is a List, Lrel or Pointer type. It is not written unless it is a Llist, Lrel, or Pointer type data type.

XML Element

Type

Description

N/A

Indicates the root node.

Sequence

Indicates zero or more elements for each attribute.

Empty
Element

Indicates an element with a name matching an object attribute name. The element has several attributes:

DataType
Signifies the integer representation of the data type.

Size
Represents the maximum size needed to store this attribute in a string.

Required
Represents the flag status of True if this attribute must be set for the object to back store.

Factory
Represents the Type name of the object if the attribute is a List, Lrel or Pointer type. It is not written unless it is a Llist, Lrel, or Pointer type data type.

More information:

Attribute Data Types