Quality management APIs
Gets a quality issue
HTTP method | GET |
URI | https://api.rambase.net/quality/issues/{qualityIssueId} |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {qualityIssueId} |
Quality issue identifier
Integer, minimum 100000 |
Custom fields | Custom fields supported |
Successful HTTP status code | 200 |
API resource identifier | 4381, version 60 |
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 |
$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. |
$showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
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.
QualityIssueId
Quality issue identifier
>{Integer}</QualityIssueId>CreatedAt
Date and time when quality issue was created
>{Datetime}</CreatedAt>Status
Status of quality issue. 1: Registering, 2: Analyzing, 4: Pending actions, 8: Reviewing, 9: Closed
Possible domain values can be found here
>{Integer}</Status>Description
Description of quality issue
>{String}</Description>Type
Quality issue type. I.E "Incident", "Observation" or "Improvement proposal"
Possible domain values can be found here
>{Integer}</Type>Title
Title of the issue
>{String}</Title>Category
Category of the quality issue. Together with type this should apply information on which field/area of a system the quality issue is addressing
Possible domain values can be found here
>{Integer}</Category>OccuredAt
Time and date when the issue occured
>{Datetime}</OccuredAt>RegisteredAt
Time and date when this issue was registered
>{Datetime}</RegisteredAt>DueDate
Time and date when this issue should be resolved
>{Date}</DueDate>ClosedAt
Time and date when this issue was resolved
>{Datetime}</ClosedAt>RiskScore
A calculated score of how much of a risk this issue indicates. It is the product of likelihood and rating (severity)
>{Integer}</RiskScore>IsMarkedForNCR
Whether or not an issue is marked as non conformance report (NCR)
>{Boolean}</IsMarkedForNCR>NotifyWhenClosed
If true, a notification will be sent to the creator when closing this issue.
>{Boolean}</NotifyWhenClosed>ExternalReference
External reference identifier from the customer
>{String}</ExternalReference>ExternalTitle
External title used in external correspondence. Is used in order to send modified title of quality issue to customer
>{String}</ExternalTitle>RequireReview
True if this issue requires a review. False if not
>{Boolean}</RequireReview>CloseComment
Additional comment added by person who closes quality issue.
>{String}</CloseComment>ReviewComment
Comment added by reviewer when they rejected review and typed some suggestions.
>{String}</ReviewComment>ReviewedAt
Date and time when quality issue was reviewed.
>{Datetime}</ReviewedAt>FolderId
File folder id for a spesific file container or forlder.
>{Integer}</FolderId>Name
Verbose folder text in english.
>{String}</Name>FolderLink
Company folder id
>{String}</FolderLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TotalCost
Total cost of the issue
>{Decimal}</TotalCost>QualityIssueActionsCount
Count of all immediate and corrective actions.
>{Integer}</QualityIssueActionsCount>DoneQualityIssueActionsCount
Count of done immediate and corrective actions.
>{Integer}</DoneQualityIssueActionsCount>QualityIssueId
Quality issue identifier
": "{Integer}",CreatedAt
Date and time when quality issue was created
": "{Datetime}",Status
Status of quality issue. 1: Registering, 2: Analyzing, 4: Pending actions, 8: Reviewing, 9: Closed
Possible domain values can be found here
": "{Integer}",Description
Description of quality issue
": "{String}",Type
Quality issue type. I.E "Incident", "Observation" or "Improvement proposal"
Possible domain values can be found here
": "{Integer}",Title
Title of the issue
": "{String}",Category
Category of the quality issue. Together with type this should apply information on which field/area of a system the quality issue is addressing
Possible domain values can be found here
": "{Integer}",OccuredAt
Time and date when the issue occured
": "{Datetime}",RegisteredAt
Time and date when this issue was registered
": "{Datetime}",DueDate
Time and date when this issue should be resolved
": "{Date}",ClosedAt
Time and date when this issue was resolved
": "{Datetime}",RiskScore
A calculated score of how much of a risk this issue indicates. It is the product of likelihood and rating (severity)
": "{Integer}",IsMarkedForNCR
Whether or not an issue is marked as non conformance report (NCR)
": "{Boolean}",NotifyWhenClosed
If true, a notification will be sent to the creator when closing this issue.
": "{Boolean}",ExternalReference
External reference identifier from the customer
": "{String}",ExternalTitle
External title used in external correspondence. Is used in order to send modified title of quality issue to customer
": "{String}",RequireReview
True if this issue requires a review. False if not
": "{Boolean}",CloseComment
Additional comment added by person who closes quality issue.
": "{String}",ReviewComment
Comment added by reviewer when they rejected review and typed some suggestions.
": "{String}",ReviewedAt
Date and time when quality issue was reviewed.
": "{Datetime}",FolderId
File folder id for a spesific file container or forlder.
": "{Integer}",Name
Verbose folder text in english.
": "{String}",FolderLink
Company folder id
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",TotalCost
Total cost of the issue
": "{Decimal}",QualityIssueActionsCount
Count of all immediate and corrective actions.
": "{Integer}",DoneQualityIssueActionsCount
Count of done immediate and corrective actions.
": "{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:
Error 105719 HTTP 403 | You do not have permission to view this file |
Error 100053 HTTP 403 | You have only admittance to your own suppliers |