Quality management APIs
Add new quality control
| HTTP method | POST |
| URI | https://api.rambase.net/quality/controls |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 5642, version 1 |
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.
Name
Required/mandatory field
Name of the quality control
>{String}</Name>Description
Description of the quality control
This field is optional.
>{String}</Description>IsReusable
Tells if quality control might be reused in many risks
Default value: True
This field is optional.
>{Boolean}</IsReusable>Name
Required/mandatory field
Name of the quality control
": "{String}",Description
Description of the quality control
This field is optional.
": "{String}",IsReusable
Tells if quality control might be reused in many risks
Default value: True
This field is optional.
": "{Boolean}"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. |
| $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] |
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.
QualityControlId
Identifier of the quality control
>{Integer}</QualityControlId>Status
Status of the quality control
Possible domain values can be found here
>{Integer}</Status>AddedAt
Date and time when control was created
>{Datetime}</AddedAt>UpdatedAt
Date and time when quality control was recently updated
>{Datetime}</UpdatedAt>Name
Name of the quality control
>{String}</Name>Description
Description of the quality control
>{String}</Description>IsReusable
Tells if quality control might be reused in many risks
>{Boolean}</IsReusable>QualityControlLink
API reference to the item
>{String}</QualityControlLink>QualityControlId
Identifier of the quality control
": "{Integer}",Status
Status of the quality control
Possible domain values can be found here
": "{Integer}",AddedAt
Date and time when control was created
": "{Datetime}",UpdatedAt
Date and time when quality control was recently updated
": "{Datetime}",Name
Name of the quality control
": "{String}",Description
Description of the quality control
": "{String}",IsReusable
Tells if quality control might be reused in many risks
": "{Boolean}",QualityControlLink
API reference to the item
": "{String}"
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 101013 HTTP 404 | Sub-module not found |
| Error 107485 HTTP 400 | Risk is accepted and cannot be modified |
| Error 107331 HTTP 400 | Risk assessment is archived and cannot be modified |
| Error 107517 HTTP 400 | Risk assessment is assessed and cannot be modified |