API

Quality management APIs

GET quality/risk-assessments/{riskAssessmentId}/grouped-actions

Get all actions from all risks belonging to this risk assessment

HTTP method GET
URI https://api.rambase.net/quality/risk-assessments/{riskAssessmentId}/grouped-actions
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {riskAssessmentId} Risk assessment identifier
Integer, minimum 100000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5236, version 13

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
$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"
$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.

AddedAt Datetime Date and time when risk action was added. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
EmployeeId Integer Employee identifier. Available macros: currentUser()
RiskActionId Integer Identifier of the risk action.
RiskId Integer Identifier of the risk.
Status Integer The status of a task.
TaskId Integer Unique task identifier.
Title String The title/summary of the task.

Read more about filters and sorting on how to use sortable parameters

EmployeeId Integer Employee identifier
RiskActionId Integer Identifier of the risk action
RiskId Integer Identifier of the risk
Status Integer The status of a task
TaskId Integer Unique task identifier
Title String The title/summary of the task

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
<GroupedActions>
2
     <GroupedAction>
3
          <Task>
4
               <TaskId
TaskId

Unique task identifier

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

The status of a task

Possible domain values can be found here

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

The title/summary of the task

>{String}</Title>
7
               <Priority
Priority

The priority of the task.

Possible domain values can be found here

>{Integer}</Priority>
8
               <DeadlineAt
DeadlineAt

Date and time of when this task must be completed.

>{Datetime}</DeadlineAt>
9
               <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=GroupedAction.Task.AssignedTo in your request URI to get this field

>
10
                    <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
14
               </AssignedTo>
15
               <TaskLink
TaskLink

Task reference

>{String}</TaskLink>
16
          </Task>
17
          <Totals
Totals

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

>
18
               <RiskActionsCount
RiskActionsCount

Tells in how many risks this task is added as an action

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

>{Integer}</RiskActionsCount>
19
               <RiskControlsCount
RiskControlsCount

Tells in how many risks this task is added to control

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

>{Integer}</RiskControlsCount>
20
               <PotentialConsequencesCount
PotentialConsequencesCount

Count of potential consequences which might be handled by this action

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

>{Integer}</PotentialConsequencesCount>
21
               <PossibleControlsCount
PossibleControlsCount

Determines in how many risks is it possible to convert this task to control

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

>{Integer}</PossibleControlsCount>
22
          </Totals>
23
          <RecentRisks
RecentRisks

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

>
24
               <Risk
Risk

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

>
25
                    <RiskId
RiskId

Identifier of the risk

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

>{Integer}</RiskId>
26
                    <Status
Status

Status of the risk

Possible domain values can be found here

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

>{Integer}</Status>
27
                    <RiskLink
RiskLink

API reference to the object

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

>{String}</RiskLink>
28
               </Risk>
29
          </RecentRisks>
30
     </GroupedAction>
31
     <Paging
Paging

Detailed paging information for this list.

>
32
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
33
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
34
          <Page
Page

Page index

>{Integer}</Page>
35
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
36
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
37
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
38
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
39
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
40
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
41
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
42
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
43
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
44
     </Paging>
45
</GroupedActions>
1
{
2
     "groupedActions": [
3
          {
4
               "task": {
5
                    "taskId
TaskId

Unique task identifier

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

The status of a task

Possible domain values can be found here

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

The title/summary of the task

": "{String}",
8
                    "priority
Priority

The priority of the task.

Possible domain values can be found here

": "{Integer}",
9
                    "deadlineAt
DeadlineAt

Date and time of when this task must be completed.

": "{Datetime}",
10
                    "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=GroupedAction.Task.AssignedTo in your request URI to get this field

": {
11
                         "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
15
                    },
16
                    "taskLink
TaskLink

Task reference

": "{String}"
17
               },
18
               "totals
Totals

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

": {
19
                    "riskActionsCount
RiskActionsCount

Tells in how many risks this task is added as an action

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

": "{Integer}",
20
                    "riskControlsCount
RiskControlsCount

Tells in how many risks this task is added to control

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

": "{Integer}",
21
                    "potentialConsequencesCount
PotentialConsequencesCount

Count of potential consequences which might be handled by this action

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

": "{Integer}",
22
                    "possibleControlsCount
PossibleControlsCount

Determines in how many risks is it possible to convert this task to control

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

": "{Integer}"
23
               },
24
               "recentRisks
RecentRisks

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

": [
25
                    {
26
                         "riskId
RiskId

Identifier of the risk

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

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

Status of the risk

Possible domain values can be found here

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

": "{Integer}",
28
                         "riskLink
RiskLink

API reference to the object

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

": "{String}"
29
                    }
30
               ]
31
          }
32
     ],
33
     "paging
Paging

Detailed paging information for this list.

": {
34
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
35
          "position
Position

Position of the first element in the list

": "{Integer}",
36
          "page
Page

Page index

": "{Integer}",
37
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",
38
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
39
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",
40
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
41
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",
42
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
43
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",
44
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
45
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
46
     }
47
}

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 101566 HTTP 404 User not found