API

Quality management APIs

GET quality/default-consequence-area/likelihoods/{likelihoodId}

Gets a likelihood from the default consequence area

HTTP method GET
URI https://api.rambase.net/quality/default-consequence-area/likelihoods/{likelihoodId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {likelihoodId} Likelihood identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 5304, version 2

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Likelihood>
2
     <LikelihoodId
LikelihoodId

Likelihood identifier

>{Integer}</LikelihoodId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
4
     <Level
Level

Likelihood level. Values from 1 to X where X is the size of the risk matrix likelihood dimension

>{Integer}</Level>
5
     <Label
Label

Label of the likelihood

>{String}</Label>
6
     <TranslatedLabel
TranslatedLabel

Translation of likelihood label

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedLabel in your request URI to get this field

>{String}</TranslatedLabel>
7
</Likelihood>
1
{
2
     "likelihood": {
3
          "likelihoodId
LikelihoodId

Likelihood identifier

": "{Integer}",
4
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
5
          "level
Level

Likelihood level. Values from 1 to X where X is the size of the risk matrix likelihood dimension

": "{Integer}",
6
          "label
Label

Label of the likelihood

": "{String}",
7
          "translatedLabel
TranslatedLabel

Translation of likelihood label

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedLabel in your request URI to get this field

": "{String}"
8
     }
9
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 107244 HTTP 400 Missing mandatory field. Both level and label are mandatory
Error 105664 HTTP 404 Could not find incident consequence