Skip to main content

Information model and API

Risks object schema#

  • Id - system automatically generats GUID number which allows the user to easily identify the exact risk in need
  • Name - each risk has a unique name which is used to define it. This is a requried field on the system
  • Description- this property is used to provide more detailed information about the risk
  • Status - is the risk's current state, which can be "active" only when it is assigned to a risk assesment, otherwise the status will be "draft"
  • ObjectOwner - is the user or team who takes the full ownership of the integrity of the given object in the system.
  • Relationships - is a list of objects which the risk is relevant for. For example, it can be relevant only for a particular design function, e.g., drive train system.
  • Deviations - List of all the deviations that are linked to the particular risk.
  • Properties - Customize the object with property definitions.

Risk assessments#

  • Id - system automatically generats GUID number which allows the user to easily identify the exact risk in need
  • Technique - A risk can be assessed using multiple different techniques. The properties for the risk assessment technique is configured in the "riskAssessmentTechnique" object
  • Risk- The risk the assessment is performed for.
  • ValidFrom - The date from which the assessment is valid from.
  • ValidTo - The date to when the assessment is relevant to.
  • Status - is the risk assesment current state.
  • Properties - Customize the object with property definitions.

Risk mitigations#

  • Id - system automatically generats GUID number which allows the user to easily identify the exact risk in need
  • Status - is the risk mitigation current state.
  • Risk- The risk the assessment is performed for.
  • MitigationOrder - The order of the mitigation. Should indicate what mitigation is recomended to perform first.
  • Properties - Customize the object with property definitions.

Defining Risk Population and Population Item#

The list of assets that are sensitive to a given risk can be grouped into on risk population(s). To define the risk population(s), the user needs to first specify the asset type(s), for which the risk is relevant for. It may be the case that the same risk is applicable for multiple asset types, therefore for multiple populations.

AssetReference#

After the choice of the asset type, the user is able to select population items via specifying assetReference attribute, e.g., if the risk population consists of 10 assets, the user is required to create 10 population items that belong to the same population id. The properties of assets can also be attached while adding the risk population items.

PopulationItemStatus#

The status of the risk population item reflects whether the item is still under the risk. The possible options for attribute status are subject to user's configuration via API. (See populationItemStatus in the schema documentation).

Obselete Endpoints#

bulk_endpoints

These bulk endpoints are obselete and not supported, and will be removed in the next version.