Quality management APIs
Report for quality issue actions for easy filtering and scheduled export possibilities.
| Report name | Quality issue actions report |
| Report identifier | 107478 |
| HTTP method | GET |
| URI | https://api.rambase.net/system/reports/107478/result-set |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 4860, 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.
| $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.
| Active() Named filter | Lists all tasks that is not done or archived yet |
| AddedByMe() Named filter | Actions added by me |
| Archive() Named filter | Lists all archived tasks |
| AssignedToMe() Named filter | Lists all tasks assigned to me |
| Done() Named filter | Lists all tasks finished |
| InProgress() Named filter | Lists all tasks in progress |
| Overdue() Named filter | Lists all overdue actions |
| ToDo() Named filter | Lists all task with Todo status |
| ActionType String | Type of an action. Immediate, corrective or suggested. |
| 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() |
| AddedByUserId Integer | Used who added this action. |
| AssignedToEmployeeId Integer | The userId of the person this task is assigned to (responsible for doing the work). |
| CompletedAt Date | The full date and time when a task was completed. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| CreatedInCompanyDatabase String | Company restriction for a task. A task is limited to the companies defined in this list. If the list is empty, all companies within the system has access to the task. |
| DeadlineAt Date | Date and time of when this task must be completed. Available macros: today(), yesterday(), 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. |
| QualityIssueId Integer | Quality issue 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". |
| TaskActivity Integer | Task type: Email, Phone call, Followup. |
| 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. |
Read more about filters and sorting on how to use sortable parameters
| ActionType String | Type of an action. Immediate, corrective or suggested |
| AddedAt Datetime | Time and date when this action was added |
| AddedByUserId Integer | Used who added this action |
| AssignedToEmployeeId Integer | The userId of the person this task is assigned to (responsible for doing the work) |
| CompletedAt Date | The full date and time when a task was completed |
| CreatedInCompanyDatabase String | Company restriction for a task. A task is limited to the companies defined in this list. If the list is empty, all companies within the system has access to the task |
| DeadlineAt Date | Date and time of when this task must be completed. |
| 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 |
| QualityIssueId Integer | Quality issue 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" |
| TaskActivity Integer | Task type: Email, Phone call, Followup |
| TaskDeadlineAt Datetime | Date and time of when this task must be completed. |
| TaskId Integer | Unique task identifier |
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.
TaskId
Unique task identifier
>{Integer}</TaskId>Title
The title/summary of the task
>{String}</Title>Description
The description of the task
>{String}</Description>DeadlineAt
Date and time of when this task must be completed.
>{Date}</DeadlineAt>CompletedAt
The full date and time when a task was completed
>{Date}</CompletedAt>Activity
Task type: Email, Phone call, Followup
Possible domain values can be found here
>{String}</Activity>AssignedTo
The userId of the person this task is assigned to (responsible for doing the work)
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>QualityIssue
Quality issue identifier
>QualityIssueId
Quality issue identifier
>{Integer}</QualityIssueId>QualityIssueLink
Quality issue reference
>{String}</QualityIssueLink>Type
Type of an action. Immediate, corrective or suggested
Possible domain values can be found here
>{String}</Type>AddedAt
Time and date when this action was added
>{Date}</AddedAt>AddedBy
Used who added this action
>UserId
User identifier
>{Integer}</UserId>FirstName
First name of the user
>{String}</FirstName>Name
Name of the user
>{String}</Name>UserLink
User reference
>{String}</UserLink>QualityCause
Title of this cause
>{String}</QualityCause>TargetApplication
Application reference when inspecting a line in a report.
>{String}</TargetApplication>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>Status
The status of a task
Possible domain values can be found here
": "{Integer}",TaskId
Unique task identifier
": "{Integer}",Title
The title/summary of the task
": "{String}",Description
The description of the task
": "{String}",DeadlineAt
Date and time of when this task must be completed.
": "{Date}",CompletedAt
The full date and time when a task was completed
": "{Date}",Activity
Task type: Email, Phone call, Followup
Possible domain values can be found here
": "{String}",AssignedTo
The userId of the person this task is assigned to (responsible for doing the work)
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"QualityIssue
Quality issue identifier
": {QualityIssueId
Quality issue identifier
": "{Integer}",QualityIssueLink
Quality issue reference
": "{String}"Type
Type of an action. Immediate, corrective or suggested
Possible domain values can be found here
": "{String}",AddedAt
Time and date when this action was added
": "{Date}",AddedBy
Used who added this action
": {UserId
User identifier
": "{Integer}",FirstName
First name of the user
": "{String}",Name
Name of the user
": "{String}",UserLink
User reference
": "{String}"QualityCause
Title of this cause
": "{String}",TargetApplication
Application reference when inspecting a line in a report.
": "{String}"
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 104920 HTTP 400 | Log text is required |
| Error 104921 HTTP 400 | Invalid log category |
| Error 101281 HTTP 400 | Too many {0} parameters. Maximum is {1}. |
| Error 100175 HTTP 400 | To date must be equal to, or later than from date. |
| Error 105710 HTTP 400 | Invalid output type |