API

Quality management APIs

GET quality/risks/{riskId}/actions/{actionId}

Get details for risk action

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

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
<RiskAction>
2
     <RiskActionId
RiskActionId

Identifier of the risk action

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

Date and time when risk action was added

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

Tells if this action was already added to controls

>{Boolean}</AddedToControl>
5
     <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

>
6
          <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>
7
          <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>
8
          <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>
9
          <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>
10
          <Priority
Priority

The priority of the 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}</Priority>
11
          <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>
12
          <DeadlineAt
DeadlineAt

Date and time of when this task must be completed.

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

>{Datetime}</DeadlineAt>
13
          <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

>
14
               <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>
15
               <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>
16
               <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>
17
               <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>
18
          </AssignedTo>
19
          <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>
20
     </Task>
21
     <RiskActionLink
RiskActionLink

API reference to the item

>{String}</RiskActionLink>
22
</RiskAction>
1
{
2
     "riskAction": {
3
          "riskActionId
RiskActionId

Identifier of the risk action

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

Date and time when risk action was added

": "{Datetime}",
5
          "addedToControl
AddedToControl

Tells if this action was already added to controls

": "{Boolean}",
6
          "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

": {
7
               "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}",
8
               "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}",
9
               "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}",
10
               "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}",
11
               "priority
Priority

The priority of the 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}",
12
               "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}",
13
               "deadlineAt
DeadlineAt

Date and time of when this task must be completed.

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

": "{Datetime}",
14
               "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

": {
15
                    "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}",
16
                    "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}",
17
                    "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}",
18
                    "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}"
19
               },
20
               "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}"
21
          },
22
          "riskActionLink
RiskActionLink

API reference to the item

": "{String}"
23
     }
24
}

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