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 better readability.

DBMS object types

For DBMS types, the DBMS dialect is added to the display name: e.g.: 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

An enumeration value is encoded as JSON structure as follows:

  • If only a display name is available, the value is a JSON structure setting the property name, e.g.: "impacts": [{"name": "Code"},{"name": "Architecture"}]
  • If only a key is available, the value is a JSON structure setting the property id, e.g.: "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, e.g.: "category": {"id": 1, "name": "Access Control List"}

Note that a display name may change over successive releases of CAST Imaging. The linkType property (refers directly to a link type ID) is an exception to this convention. If there is need to report a display name the linkTypeName property would be introduced.