Quality management APIs
All actions for all quality issues
| HTTP method | GET |
| URI | https://api.rambase.net/quality/issue-actions |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 4646, version 10 |
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.
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.
| $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 | Time and date when this action was added. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| QualityIssueCategory Integer | Category of the quality issue. Together with type this should apply information on which field/area of a system the quality issue is addressing. |
| QualityIssueCreatedAt Datetime | Date and time when quality issue was created. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| QualityIssueDepartmentId Integer | Department identifier. |
| QualityIssueStatus Integer | Status of quality issue. 1: Registering, 2: Analyzing, 4: Pending actions, 8: Reviewing, 9: Closed. |
| QualityIssueType Integer | Quality issue type. I.E "Incident", "Observation" or "Improvement proposal". |
| TaskDeadlineAt Datetime | Date and time of when this task must be completed. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| TaskId Integer | Unique task identifier. |
| TaskStatus Integer | The status of a task. |
| Type String | Type of an action. Immediate, corrective or suggested. |
Read more about filters and sorting on how to use sortable parameters
| AddedAt Datetime | Time and date when this action was added |
| QualityIssueCategory Integer | Category of the quality issue. Together with type this should apply information on which field/area of a system the quality issue is addressing |
| QualityIssueCreatedAt Datetime | Date and time when quality issue was created |
| QualityIssueDepartmentId Integer | Department identifier |
| QualityIssueStatus Integer | Status of quality issue. 1: Registering, 2: Analyzing, 4: Pending actions, 8: Reviewing, 9: Closed |
| QualityIssueType Integer | Quality issue type. I.E "Incident", "Observation" or "Improvement proposal" |
| TaskDeadlineAt Datetime | Date and time of when this task must be completed. |
| TaskId Integer | Unique task identifier |
| Type String | Type of an action. Immediate, corrective or suggested |
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.
QualityIssueActionId
Action identifier
>{Integer}</QualityIssueActionId>TaskId
Unique task identifier
>{Integer}</TaskId>TaskLink
Task reference
>{String}</TaskLink>QualityIssueId
Quality issue identifier
>{Integer}</QualityIssueId>QualityIssueLink
Quality issue reference
>{String}</QualityIssueLink>QualityIssueActionLink
Quality issue action document reference
>{String}</QualityIssueActionLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>QualityIssueActionId
Action identifier
": "{Integer}",TaskId
Unique task identifier
": "{Integer}",TaskLink
Task reference
": "{String}"QualityIssueId
Quality issue identifier
": "{Integer}",QualityIssueLink
Quality issue reference
": "{String}"QualityIssueActionLink
Quality issue action document reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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: