Conventions

Annotations

The keyword RESERVED annotation means the feature is not yet implemented, and the feature specification has not been finalized.

JSON Responses

The JSON properties are ordered by property name. However, the provided examples may not follow this rule for a better readability.

DBMS Object Types Convention

WARNING:

For DBMS types, the DBMS dialect is added to the display name: ex ‘Oracle Table’, ‘PostgreSQL Table’, etc.

Therefore, there is not a univoque relationship between the object type property (display name of type), and the object typeId property (key of type).

For example, for an object of type SQLScriptTable, the type name will be one of these labels: Oracle Table, PostgreSQL Table, etc.

Enum Types Conventions

An enumeration value is encoded as JSON structure as follow:

• If only a display name is available, the value is a JSON structure setting the property ‘name’ ex: "impacts": [{"name": "Code"},{"name": "Architecture"}]
  
• If only a key is available, the value is a JSON structure setting the property ‘id’
  ex: "criticality": {"id": "CRITICAL"}
  
• If both a key and a display name are available, the value is a JSON structure setting both property ‘name’ and ‘id’:
  ex: "category": {"id": 1, "name": "Access Control List"}
  

WARNING:

A display name may change over Imaging versions.

The linkType property is an exception to this convention, this property refers directly to a link type ID. 

If ever we would need to report a display name we would introduce the linkTypeName property.