Model object class metadata

The model object class metadata resource represents the metadata describing the attributes of a model object class.

Description

Use the model object class metadata resource to query data about the attributes of a specified model object class, including the number, type, and name of each attribute. This information is equivalent to that returned by the Java™ getMetaData() method.

The metadata can be returned in either JSON or XML format.

URL

scheme//hostname:port/rest/model/meta/model_object_class

where:

scheme: The scheme of the URL (either HTTP: or HTTPS:).
hostname: The TCP/IP hostname or numeric IP address of the TADDM server.
port: The TCP/IP port on the TADDM server for the type of connection you are using (9430 for HTTP, or 9431 for HTTPS).
model_object_class: The name of a Common Data Model object class.

HTTP methods

GET: Queries object class metadata.

Parameters

feed={json|xml}

The format to use for the returned data. Specify json or xml. This parameter is optional.

If you do not specify the feed parameter, the server uses the format specified by the HTTP Accept header (application/json or application/xml). If this header is not specified, the results are returned in JSON format.

Example

This example queries metadata information for the ComputerSystem model object:

http://example.com:9430/rest/model/meta/ComputerSystem?feed=json

This example shows JSON output from a metadata query:

[{"type":"java.lang.String","column":"BOOTORDER_X","length":192,"name":
"bootOrder","arrayType":false,"_class":"ObjectAttribute","timestampType
":false,"displayString":"Boot Order"}, {"type":"com.collation.platform.
model.topology.sys.zOS.ZReportFile","table":"COMPUTERSYSTILES_935A6002X
","column":"PK__ZREPORTFILES_X","length":192,"name":"ZReportfiles","arr
ayType":true,"reverseRelationship":true,"_class":"ObjectAttribute","rel
ationshipType":"com.collation.platform.model.topology.relation.AppliesT
o","timestampType":false,"displayString":"z\/OS Report File"}]

This example shows partial XML output of a metadata query:

<ObjectAttribute array="22" xsi:type="coll:com.collation.platform.model
.topology.meta.ObjectAttribute">
  <name>OSRunning</name> 
  <type>com.collation.platform.model.topology.sys.OperatingSystem</type>
  <arrayType>false</arrayType> 
  <timestampType>false</timestampType> 
  <length>192</length> 
  <relationshipType>com.collation.platform.model.topology.relation.Runs
On</relationshipType> 
  <reverseRelationship>true</reverseRelationship> 
  <displayString>OS Running</displayString> 
  <column>PK__OSRUNNING_X</column> 
  <displayName /> 
</ObjectAttribute>