API

Quality management APIs

GET quality/risk-assessments?folderId={folderId}&includeSubfolders={includeSubfolders}

Shows list of risk assessments

HTTP method GET
URI https://api.rambase.net/quality/risk-assessments?folderId={folderId}&includeSubfolders={includeSubfolders}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 5105, version 33

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.

folderId Integer, optional File folder id for a spesific file container or forlder.

Minimum: 100000
includeSubfolders Boolean, optional Includes risk assessments from subfolders, not only from current folder.
$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"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$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.

Active() Named filter Show all active risk assessment which means with status lower than 9
Archived() Named filter Risk assessments which were archived
Assessed() Named filter Risk assessments which were assessed and their status is 4
MeAsResponsible() Named filter Me as responsible
NotReassessed() Named filter Risk assessments which were not reassessed yet
Overdue() Named filter Not reassessed risk assessements after planned assessment date
Planning() Named filter Risk assessments in planning status
Reassessed() Named filter Risk assessments which were already reassessed
Template() Named filter Filters all risk assessments marked as templates
UnderAssessment() Named filter Assessing and defining risks
AssessmentDate Date When current assessment was prepared. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedAt Datetime Date and time when risk assessment was created. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
InitialRiskAssessmentId Integer Identifier of the first assessment in this line of reassessments.
IsTemplate Boolean This field indicates if risk assessment is marked as a template assessment.
Limitations String Limitations of the risk assessment.
LocationId Integer Location identifier.
Name String Name of the risk assessment.
NegativeScore Integer Score of the potential consequence. Calculated from severity rating multiplied with likelihood level.
NextAssessmentDate Date Date when update of the current risk assessment is planned. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
PositiveScore Integer Score of the potential consequence. Calculated from severity rating multiplied with likelihood level.
ReAssessmentId Integer Identifier of the next re-assessment.
ResponsibleId Integer Employee identifier. Available macros: currentUser()
RiskAssessmentId Integer Risk assessment identifier.
Scope String Scope of the risk assessment.
SourceObjectId Integer Identifier of the object.
SourceObjectType String Type of object.
Status Integer Status of risk assessment.

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

AssessmentDate Date When current assessment was prepared
CreatedAt Datetime Date and time when risk assessment was created
InitialRiskAssessmentId Integer Identifier of the first assessment in this line of reassessments
IsTemplate Boolean This field indicates if risk assessment is marked as a template assessment
LocationId Integer Location identifier
Name String Name of the risk assessment
NegativeScore Integer Score of the potential consequence. Calculated from severity rating multiplied with likelihood level
NextAssessmentDate Date Date when update of the current risk assessment is planned
PositiveScore Integer Score of the potential consequence. Calculated from severity rating multiplied with likelihood level
ReAssessmentId Integer Identifier of the next re-assessment
ResponsibleId Integer Employee identifier
RiskAssessmentId Integer Risk assessment identifier
SourceObjectId Integer Identifier of the object
SourceObjectType String Type of object
Status Integer Status of risk assessment

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
<RiskAssessments>
2
     <RiskAssessment>
3
          <RiskAssessmentId
RiskAssessmentId

Risk assessment identifier

>{Integer}</RiskAssessmentId>
4
          <AssessmentDate
AssessmentDate

When current assessment was prepared

>{Date}</AssessmentDate>
5
          <CreatedAt
CreatedAt

Date and time when risk assessment was created

>{Datetime}</CreatedAt>
6
          <Limitations
Limitations

Limitations of the risk assessment

>{String}</Limitations>
7
          <Name
Name

Name of the risk assessment

>{String}</Name>
8
          <ReAssessmentInterval
ReAssessmentInterval

Re-assessment interval

Possible domain values can be found here

>{Integer}</ReAssessmentInterval>
9
          <NextAssessmentDate
NextAssessmentDate

Date when update of the current risk assessment is planned

>{Date}</NextAssessmentDate>
10
          <Status
Status

Status of risk assessment

Possible domain values can be found here

>{Integer}</Status>
11
          <Scope
Scope

Scope of the risk assessment

>{String}</Scope>
12
          <IsTemplate
IsTemplate

This field indicates if risk assessment is marked as a template assessment

>{Boolean}</IsTemplate>
13
          <Folder>
14
               <FolderId
FolderId

File folder id for a spesific file container or forlder.

>{Integer}</FolderId>
15
               <Name
Name

Verbose folder text in english.

>{String}</Name>
16
               <FolderLink
FolderLink

Company folder id

>{String}</FolderLink>
17
          </Folder>
18
          <InitialRiskAssessment>
19
               <RiskAssessmentId
RiskAssessmentId

Identifier of the first assessment in this line of reassessments

>{Integer}</RiskAssessmentId>
20
               <RiskAssessmentLink
RiskAssessmentLink

API reference to the object

>{String}</RiskAssessmentLink>
21
          </InitialRiskAssessment>
22
          <PositiveScore
PositiveScore

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

>
23
               <Score
Score

Score of the potential consequence. Calculated from severity rating multiplied with likelihood level

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

>{Integer}</Score>
24
               <QualityConsequenceArea
QualityConsequenceArea

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

>
25
                    <LowerThreshold
LowerThreshold

Threshold for risk scores. Values less than or equal to this threshold will have a low risk. Medium or higher risks have risk scores greater than this threshold value

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

>{Integer}</LowerThreshold>
26
                    <UpperThreshold
UpperThreshold

Threshold for risk scores. Values less than this threshold will have a low or medium risk. High risks will have risk scores greater than or equal to this threshold value

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

>{Integer}</UpperThreshold>
27
               </QualityConsequenceArea>
28
          </PositiveScore>
29
          <NegativeScore
NegativeScore

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

>
30
               <Score
Score

Score of the potential consequence. Calculated from severity rating multiplied with likelihood level

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

>{Integer}</Score>
31
               <QualityConsequenceArea
QualityConsequenceArea

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

>
32
                    <LowerThreshold
LowerThreshold

Threshold for risk scores. Values less than or equal to this threshold will have a low risk. Medium or higher risks have risk scores greater than this threshold value

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

>{Integer}</LowerThreshold>
33
                    <UpperThreshold
UpperThreshold

Threshold for risk scores. Values less than this threshold will have a low or medium risk. High risks will have risk scores greater than or equal to this threshold value

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

>{Integer}</UpperThreshold>
34
               </QualityConsequenceArea>
35
          </NegativeScore>
36
          <Responsible
Responsible

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

>
37
               <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
41
          </Responsible>
42
          <Location
Location

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

>
43
               <LocationId
LocationId

Location identifier

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

>{Integer}</LocationId>
44
               <ShortName
ShortName

Unique abbreviation/short name of the location

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

>{String}</ShortName>
45
               <LocationLink
LocationLink

Location reference

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

>{String}</LocationLink>
46
          </Location>
47
          <Totals
Totals

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

>
48
               <AcceptedRisksCount
AcceptedRisksCount

Count of accepted risks that belong to this risk assessment

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

>{Integer}</AcceptedRisksCount>
49
               <RisksCount
RisksCount

Count of all risks that belong to this risk assessment

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

>{Integer}</RisksCount>
50
               <ParticipantsCount
ParticipantsCount

Count of participants

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

>{Integer}</ParticipantsCount>
51
               <ActionsCount
ActionsCount

Number of actions related to this risk assessment

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

>{Integer}</ActionsCount>
52
               <ControlsCount
ControlsCount

Number of controls related to this risk assessment

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

>{Integer}</ControlsCount>
53
          </Totals>
54
          <Context
Context

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

>
55
               <Source
Source

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

>
56
                    <ObjectId
ObjectId

Identifier of the object

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

>{Integer}</ObjectId>
57
                    <ObjectType
ObjectType

Type of object

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

>{String}</ObjectType>
58
                    <ObjectLink
ObjectLink

API reference to the object

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

>{String}</ObjectLink>
59
               </Source>
60
          </Context>
61
          <RiskAssessmentLink
RiskAssessmentLink

API reference to the object

>{String}</RiskAssessmentLink>
62
     </RiskAssessment>
63
     <Paging
Paging

Detailed paging information for this list.

>
64
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
67
          <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>
68
          <FirstPage
FirstPage

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

>{String}</FirstPage>
69
          <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>
70
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
71
          <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>
72
          <NextPage
NextPage

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

>{String}</NextPage>
73
          <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>
74
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
76
     </Paging>
77
</RiskAssessments>
1
{
2
     "riskAssessments": [
3
          {
4
               "riskAssessmentId
RiskAssessmentId

Risk assessment identifier

": "{Integer}",
5
               "assessmentDate
AssessmentDate

When current assessment was prepared

": "{Date}",
6
               "createdAt
CreatedAt

Date and time when risk assessment was created

": "{Datetime}",
7
               "limitations
Limitations

Limitations of the risk assessment

": "{String}",
8
               "name
Name

Name of the risk assessment

": "{String}",
9
               "reAssessmentInterval
ReAssessmentInterval

Re-assessment interval

Possible domain values can be found here

": "{Integer}",
10
               "nextAssessmentDate
NextAssessmentDate

Date when update of the current risk assessment is planned

": "{Date}",
11
               "status
Status

Status of risk assessment

Possible domain values can be found here

": "{Integer}",
12
               "scope
Scope

Scope of the risk assessment

": "{String}",
13
               "isTemplate
IsTemplate

This field indicates if risk assessment is marked as a template assessment

": "{Boolean}",
14
               "folder": {
15
                    "folderId
FolderId

File folder id for a spesific file container or forlder.

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

Verbose folder text in english.

": "{String}",
17
                    "folderLink
FolderLink

Company folder id

": "{String}"
18
               },
19
               "initialRiskAssessment": {
20
                    "riskAssessmentId
RiskAssessmentId

Identifier of the first assessment in this line of reassessments

": "{Integer}",
21
                    "riskAssessmentLink
RiskAssessmentLink

API reference to the object

": "{String}"
22
               },
23
               "positiveScore
PositiveScore

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

": {
24
                    "score
Score

Score of the potential consequence. Calculated from severity rating multiplied with likelihood level

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

": "{Integer}",
25
                    "qualityConsequenceArea
QualityConsequenceArea

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

": {
26
                         "lowerThreshold
LowerThreshold

Threshold for risk scores. Values less than or equal to this threshold will have a low risk. Medium or higher risks have risk scores greater than this threshold value

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

": "{Integer}",
27
                         "upperThreshold
UpperThreshold

Threshold for risk scores. Values less than this threshold will have a low or medium risk. High risks will have risk scores greater than or equal to this threshold value

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

": "{Integer}"
28
                    }
29
               },
30
               "negativeScore
NegativeScore

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

": {
31
                    "score
Score

Score of the potential consequence. Calculated from severity rating multiplied with likelihood level

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

": "{Integer}",
32
                    "qualityConsequenceArea
QualityConsequenceArea

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

": {
33
                         "lowerThreshold
LowerThreshold

Threshold for risk scores. Values less than or equal to this threshold will have a low risk. Medium or higher risks have risk scores greater than this threshold value

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

": "{Integer}",
34
                         "upperThreshold
UpperThreshold

Threshold for risk scores. Values less than this threshold will have a low or medium risk. High risks will have risk scores greater than or equal to this threshold value

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

": "{Integer}"
35
                    }
36
               },
37
               "responsible
Responsible

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

": {
38
                    "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
42
               },
43
               "location
Location

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

": {
44
                    "locationId
LocationId

Location identifier

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

": "{Integer}",
45
                    "shortName
ShortName

Unique abbreviation/short name of the location

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

": "{String}",
46
                    "locationLink
LocationLink

Location reference

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

": "{String}"
47
               },
48
               "totals
Totals

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

": {
49
                    "acceptedRisksCount
AcceptedRisksCount

Count of accepted risks that belong to this risk assessment

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

": "{Integer}",
50
                    "risksCount
RisksCount

Count of all risks that belong to this risk assessment

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

": "{Integer}",
51
                    "participantsCount
ParticipantsCount

Count of participants

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

": "{Integer}",
52
                    "actionsCount
ActionsCount

Number of actions related to this risk assessment

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

": "{Integer}",
53
                    "controlsCount
ControlsCount

Number of controls related to this risk assessment

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

": "{Integer}"
54
               },
55
               "context
Context

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

": {
56
                    "source
Source

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

": {
57
                         "objectId
ObjectId

Identifier of the object

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

": "{Integer}",
58
                         "objectType
ObjectType

Type of object

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

": "{String}",
59
                         "objectLink
ObjectLink

API reference to the object

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

": "{String}"
60
                    }
61
               },
62
               "riskAssessmentLink
RiskAssessmentLink

API reference to the object

": "{String}"
63
          }
64
     ],
65
     "paging
Paging

Detailed paging information for this list.

": {
66
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
69
          "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}",
70
          "firstPage
FirstPage

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

": "{String}",
71
          "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}",
72
          "previousPage
PreviousPage

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

": "{String}",
73
          "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}",
74
          "nextPage
NextPage

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

": "{String}",
75
          "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}",
76
          "lastPage
LastPage

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

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

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

": "{Integer}"
78
     }
79
}

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 100199 HTTP 404 Location not found