Quality management APIs
Add new risk
| HTTP method | POST |
| URI | https://api.rambase.net/quality/risks |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 5206, version 4 |
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.
Title
Required/mandatory field
Title of the risk
>{String}</Title>Description
Description of the risk
This field is optional.
>{String}</Description>RiskAssessment
This field is optional.
>RiskAssessmentId
Risk assessment identifier
Minimum value: 100000
This field is optional.
>{Integer}</RiskAssessmentId>EmployeeId
Required/mandatory field
Employee identifier
Minimum value: 100
>{Integer}</EmployeeId>Context
This field is optional.
>Source
This field is optional.
>ObjectId
Identifier of the object
This field is optional.
>{Integer}</ObjectId>ObjectType
Type of object
This field is optional.
>{String}</ObjectType>ItemId
Item-number of the object
This field is optional.
>{Integer}</ItemId>Title
Required/mandatory field
Title of the risk
": "{String}",Description
Description of the risk
This field is optional.
": "{String}",RiskAssessment
This field is optional.
": {RiskAssessmentId
Risk assessment identifier
Minimum value: 100000
This field is optional.
": "{Integer}"EmployeeId
Required/mandatory field
Employee identifier
Minimum value: 100
": "{Integer}"Context
This field is optional.
": {Source
This field is optional.
": {ObjectId
Identifier of the object
This field is optional.
": "{Integer}",ObjectType
Type of object
This field is optional.
": "{String}",ItemId
Item-number of the object
This field is optional.
": "{Integer}"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.
| $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 |
| $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. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
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 103580 HTTP 404 | Setting definition not found |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 107222 HTTP 400 | Updates are not allowed when risk assessment is in status 4 or above |
| Error 107293 HTTP 400 | Positive score cannot be lower than zero |
| Error 107294 HTTP 400 | Negative score cannot be bigger than zero |