Quality management APIs
Creates new control out of quality control
| HTTP method | POST |
| URI | https://api.rambase.net/quality/risks/{riskId}/controls |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {riskId} |
Identifier of the risk
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 5215, version 6 |
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.
QualityControlId
Required/mandatory field
Identifier of the quality control
Minimum value: 100000
>{Integer}</QualityControlId>QualityControlId
Required/mandatory field
Identifier of the quality control
Minimum value: 100000
": "{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. |
| $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.
ControlId
Identifier of the control
>{Integer}</ControlId>AddedAt
Date and time when control was added
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>QualityControlId
Identifier of the quality control
>{Integer}</QualityControlId>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>TaskId
Unique task identifier
>{Integer}</TaskId>Title
The title/summary of the task
>{String}</Title>Description
The description of the task
>{String}</Description>Activity
Task type: Email, Phone call, Followup
Possible domain values can be found here
>{Integer}</Activity>AssignedTo
The userId of the person this task is assigned to (responsible for doing the work)
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>TaskLink
Task reference
>{String}</TaskLink>ControlId
Identifier of the control
": "{Integer}",AddedAt
Date and time when control was added
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"QualityControlId
Identifier of the quality control
": "{Integer}",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}",TaskId
Unique task identifier
": "{Integer}",Status
The status of a task
Possible domain values can be found here
": "{Integer}",Title
The title/summary of the task
": "{String}",Description
The description of the task
": "{String}",Activity
Task type: Email, Phone call, Followup
Possible domain values can be found here
": "{Integer}",AssignedTo
The userId of the person this task is assigned to (responsible for doing the work)
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"TaskLink
Task reference
": "{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 100027 HTTP 400 | Missing mandatory parameter {0} |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 107517 HTTP 400 | Risk assessment is assessed and cannot be modified |