API

Quality management APIs

GET quality/risks/{riskId}/controls/{controlId}

Gets details for risk control

HTTP method GET
URI https://api.rambase.net/quality/risks/{riskId}/controls/{controlId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {riskId} Identifier of the risk
Integer, minimum 100000
- URI parameter {controlId} Identifier of the control
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 5219, version 7

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.

$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
$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
<Control>
2
     <ControlId
ControlId

Identifier of the control

>{Integer}</ControlId>
3
     <AddedAt
AddedAt

Date and time when control was added

>{Datetime}</AddedAt>
4
     <AddedBy
AddedBy

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

>
5
          <EmployeeId
EmployeeId

Employee identifier

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

>{Integer}</EmployeeId>
6
          <LastName
LastName

Last name of employee

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

>{String}</LastName>
7
          <FirstName
FirstName

First name of employee

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

>{String}</FirstName>
8
          <EmployeeLink
EmployeeLink

Employee reference

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

>{String}</EmployeeLink>
9
     </AddedBy>
10
     <QualityControl>
11
          <QualityControlId
QualityControlId

Identifier of the quality control

>{Integer}</QualityControlId>
12
          <Name
Name

Name of the quality control

>{String}</Name>
13
          <Description
Description

Description of the quality control

>{String}</Description>
14
          <IsReusable
IsReusable

Tells if quality control might be reused in many risks

>{Boolean}</IsReusable>
15
          <TranslatedName
TranslatedName

Name of the control translated to the user's current language

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

>{String}</TranslatedName>
16
          <TranslatedDescription
TranslatedDescription

Description of the control translated to the user's current language

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

>{String}</TranslatedDescription>
17
          <QualityControlLink
QualityControlLink

API reference to the item

>{String}</QualityControlLink>
18
     </QualityControl>
19
     <Task
Task

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

>
20
          <TaskId
TaskId

Unique task identifier

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

>{Integer}</TaskId>
21
          <Status
Status

The status of a task

Possible domain values can be found here

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

>{Integer}</Status>
22
          <Title
Title

The title/summary of the task

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

>{String}</Title>
23
          <Description
Description

The description of the task

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

>{String}</Description>
24
          <Activity
Activity

Task type: Email, Phone call, Followup

Possible domain values can be found here

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

>{Integer}</Activity>
25
          <AssignedTo
AssignedTo

The userId of the person this task is assigned to (responsible for doing the work)

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

>
26
               <EmployeeId
EmployeeId

Employee identifier

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

>{Integer}</EmployeeId>
27
               <LastName
LastName

Last name of employee

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

>{String}</LastName>
28
               <FirstName
FirstName

First name of employee

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

>{String}</FirstName>
29
               <EmployeeLink
EmployeeLink

Employee reference

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

>{String}</EmployeeLink>
30
          </AssignedTo>
31
          <TaskLink
TaskLink

Task reference

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

>{String}</TaskLink>
32
     </Task>
33
</Control>
1
{
2
     "control": {
3
          "controlId
ControlId

Identifier of the control

": "{Integer}",
4
          "addedAt
AddedAt

Date and time when control was added

": "{Datetime}",
5
          "addedBy
AddedBy

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

": {
6
               "employeeId
EmployeeId

Employee identifier

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

": "{Integer}",
7
               "lastName
LastName

Last name of employee

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

": "{String}",
8
               "firstName
FirstName

First name of employee

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

": "{String}",
9
               "employeeLink
EmployeeLink

Employee reference

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

": "{String}"
10
          },
11
          "qualityControl": {
12
               "qualityControlId
QualityControlId

Identifier of the quality control

": "{Integer}",
13
               "name
Name

Name of the quality control

": "{String}",
14
               "description
Description

Description of the quality control

": "{String}",
15
               "isReusable
IsReusable

Tells if quality control might be reused in many risks

": "{Boolean}",
16
               "translatedName
TranslatedName

Name of the control translated to the user's current language

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

": "{String}",
17
               "translatedDescription
TranslatedDescription

Description of the control translated to the user's current language

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

": "{String}",
18
               "qualityControlLink
QualityControlLink

API reference to the item

": "{String}"
19
          },
20
          "task
Task

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

": {
21
               "taskId
TaskId

Unique task identifier

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

": "{Integer}",
22
               "status
Status

The status of a task

Possible domain values can be found here

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

": "{Integer}",
23
               "title
Title

The title/summary of the task

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

": "{String}",
24
               "description
Description

The description of the task

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

": "{String}",
25
               "activity
Activity

Task type: Email, Phone call, Followup

Possible domain values can be found here

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

": "{Integer}",
26
               "assignedTo
AssignedTo

The userId of the person this task is assigned to (responsible for doing the work)

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

": {
27
                    "employeeId
EmployeeId

Employee identifier

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

": "{Integer}",
28
                    "lastName
LastName

Last name of employee

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

": "{String}",
29
                    "firstName
FirstName

First name of employee

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

": "{String}",
30
                    "employeeLink
EmployeeLink

Employee reference

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

": "{String}"
31
               },
32
               "taskLink
TaskLink

Task reference

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

": "{String}"
33
          }
34
     }
35
}

Possible error codes the response might return:

Error 101606 HTTP 404 Module not found
Error 108271 HTTP 403 You are not authorized to view this process