Quality management APIs
Gets all risks
HTTP method | GET |
URI | https://api.rambase.net/quality/risks |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 80 |
Custom fields | Custom fields supported |
Successful HTTP status code | 200 |
API resource identifier | 5205, version 32 |
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.
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.
$showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
$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 |
$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. |
$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. |
$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. |
$format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
$showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
$top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
$pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
$filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
$orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
$inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
AcceptedRisks() Named filter | Risks which were accepted and are in status 4 |
Archived() Named filter | Risks in status 9 were archived |
DuringIdentification() Named filter | Risks which are during identification |
HighOpportunity() Named filter | Risks with high positive score, greater or equal to upper threshold |
HighRisk() Named filter | Risks with high score within red range |
LowOpportunity() Named filter | Risks with positive score lower than lower threshold |
LowRisk() Named filter | Risks with low score within green range |
MediumOpportunity() Named filter | Risks with medium positive score, greater of equal to lower threshold and lower than upper threshold |
MediumRisk() Named filter | Risks with medium score within yellow range |
MyRisks() Named filter | Risks owned by me |
PendingAnalysing() Named filter | Risks which are analyzed |
PendingHandling() Named filter | Risks in status 3 are waiting for completion of all actions |
Template() Named filter | Filters all risk assessments marked as templates |
ContainingConsequenceAreaId Integer | Quality consequence identifier. |
ContainingControlTaskId Integer | It is possible to filter by quality control identifier which is referencing this potential consequence in controls. |
ContainingDepartmentId Integer | Department identifier. |
ContainingHighestNegativeConsequenceAreaId Integer | Filter field for if the most severe negative itm1 is containing a specific consequence area id. |
ContainingHighestNegativeConsequenceTypeId Integer | Filters by potential consequences containing specific consequence type and score must be highest in this risk. |
ContainingHighestPositiveConsequenceAreaId Integer | Filter field for if the most impactful positive itm1 is contianing a specific consequence area id. |
ContainingHighestPositiveConsequenceTypeId Integer | Filters risk by positive potential consequences contaning specific consequence type with highest positive score. |
ContainingNegativeConsequenceAreaId Integer | Filter field for if the most severe negative itm1 is containing a specific consequence area id. |
ContainingNegativeConsequenceTypeId Integer | Filters risks which contain negative potential consequence with specific consequence type. |
ContainingPositiveConsequenceAreaId Integer | Filter field for if the most impactful positive itm1 is contianing a specific consequence area id. |
ContainingPositiveConsequenceTypeId Integer | Filters risks containing positive potential consequence with specific consequence type. |
ContainingTaskId Integer | Filters for risks with action, which references specific task. |
CreatedAt Datetime | Date and time when risk was created. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
Description String | Description of the risk. |
IsTemplate Boolean | This field indicates if risk assessment is marked as a template assessment. |
NegativeLowerThreshold Integer | Lower threshold for negative scores. |
NegativeScore Integer | Lowest negative score from potential consequences for this risk. |
NegativeScoreLikelihoodLevel Integer | Likelihood level. Values from 1 to X where X is the size of the risk matrix likelihood dimension. |
NegativeScoreSeverityLevel Integer | Severity describes how severe a consequence is. |
NegativeUpperThreshold Integer | Upper threshold for negative scores. |
OwnerId Integer | Employee identifier. Available macros: currentUser() |
PositiveLowerThreshold Integer | Lower threshold for positive scores. |
PositiveScore Integer | Maximum positive score from potential consequences for this risk. |
PositiveScoreLikelihoodLevel Integer | Likelihood level. Values from 1 to X where X is the size of the risk matrix likelihood dimension. |
PositiveScoreSeverityLevel Integer | Severity describes how severe a consequence is. |
PositiveUpperThreshold Integer | Upper threshold for positive scores. |
RiskAssessmentId Integer | Risk assessment identifier. |
RiskId Integer | Identifier of the risk. |
SourceItemId Integer | Item-number of the object. |
SourceObjectId Integer | Identifier of the object. |
SourceObjectType String | Type of object. |
Status Integer | Status of the risk. |
Title String | Title of the risk. |
UpdatedAt Datetime | Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
Read more about filters and sorting on how to use sortable parameters
ContainingControlTaskId Integer | It is possible to filter by quality control identifier which is referencing this potential consequence in controls |
ContainingHighestNegativeConsequenceAreaId Integer | Filter field for if the most severe negative itm1 is containing a specific consequence area id |
ContainingHighestNegativeConsequenceTypeId Integer | Filters by potential consequences containing specific consequence type and score must be highest in this risk |
ContainingHighestPositiveConsequenceAreaId Integer | Filter field for if the most impactful positive itm1 is contianing a specific consequence area id |
ContainingHighestPositiveConsequenceTypeId Integer | Filters risk by positive potential consequences contaning specific consequence type with highest positive score |
ContainingNegativeConsequenceAreaId Integer | Filter field for if the most severe negative itm1 is containing a specific consequence area id |
ContainingNegativeConsequenceTypeId Integer | Filters risks which contain negative potential consequence with specific consequence type |
ContainingPositiveConsequenceAreaId Integer | Filter field for if the most impactful positive itm1 is contianing a specific consequence area id |
ContainingPositiveConsequenceTypeId Integer | Filters risks containing positive potential consequence with specific consequence type |
ContainingTaskId Integer | Filters for risks with action, which references specific task |
CreatedAt Datetime | Date and time when risk was created |
IsTemplate Boolean | This field indicates if risk assessment is marked as a template assessment |
NegativeLowerThreshold Integer | Lower threshold for negative scores. |
NegativeScore Integer | Lowest negative score from potential consequences for this risk |
NegativeScoreLikelihoodLevel Integer | Likelihood level. Values from 1 to X where X is the size of the risk matrix likelihood dimension |
NegativeScoreSeverityLevel Integer | Severity describes how severe a consequence is. |
NegativeUpperThreshold Integer | Upper threshold for negative scores |
OwnerId Integer | Employee identifier |
PositiveLowerThreshold Integer | Lower threshold for positive scores |
PositiveScore Integer | Maximum positive score from potential consequences for this risk |
PositiveScoreLikelihoodLevel Integer | Likelihood level. Values from 1 to X where X is the size of the risk matrix likelihood dimension |
PositiveScoreSeverityLevel Integer | Severity describes how severe a consequence is. |
PositiveUpperThreshold Integer | Upper threshold for positive scores |
RiskAssessmentId Integer | Risk assessment identifier |
RiskId Integer | Identifier of the risk |
SourceItemId Integer | Item-number of the object |
SourceObjectId Integer | Identifier of the object |
SourceObjectType String | Type of object |
Status Integer | Status of the risk |
Title String | Title of the risk |
UpdatedAt Datetime | Date and time of update |
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.
RiskId
Identifier of the risk
>{Integer}</RiskId>CreatedAt
Date and time when risk was created
>{Datetime}</CreatedAt>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>Title
Title of the risk
>{String}</Title>Description
Description of the risk
>{String}</Description>RiskLink
API reference to the object
>{String}</RiskLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>RiskId
Identifier of the risk
": "{Integer}",CreatedAt
Date and time when risk was created
": "{Datetime}",UpdatedAt
Date and time of update
": "{Datetime}",Status
Status of the risk
Possible domain values can be found here
": "{Integer}",Title
Title of the risk
": "{String}",Description
Description of the risk
": "{String}",RiskLink
API reference to the object
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 101814 HTTP 404 | Employee not found |