Retrieve an issue

Updated:

GET/qms/{connection_id}/issue/{id}

Retrieves a single QmsIssue by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Issue

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
numberstringNoIssue number, e.g. NCR-0042
namestringNo
descriptionstringNo
typeenumNoValues: NONCONFORMANCE, COMPLAINT, AUDIT_FINDING, PROBLEM_REPORT, OTHER
original_typestringNoThe vendor's own issue type or template name
statusenumNoNormalized status of a quality record Values: OPEN, IN_PROGRESS, IN_REVIEW, CLOSED, CANCELLED
lifecycle_statestringNoVendor's own state or workflow step name
severityenumNoValues: LOW, MEDIUM, HIGH, CRITICAL
sourceenumNoWhere a quality issue was found Values: INTERNAL, SUPPLIER, CUSTOMER, AUDIT, OTHER
dispositionenumNoWhat to do with the nonconforming material Values: USE_AS_IS, REWORK, REPAIR, SCRAP, RETURN_TO_VENDOR, OTHER
original_dispositionstringNoThe vendor's own disposition name
affected_itemsQmsAffectedItem[]No
affected_items[].part_idstringNoThe PlmPart (revision) ID, when the same vendor also provides PLM
affected_items[].document_idstringNoThe PlmDocument ID, when the same vendor also provides PLM
affected_items[].part_numberstringNo
affected_items[].revisionstringNo
affected_items[].lot_numberstringNo
affected_items[].serial_numberstringNo
affected_items[].quantitynumberNoQuantity affected
supplier_namestringNo
user_idstringNoOwner or assignee (reference to HrisEmployee)
reporter_user_idstringNoWho raised the issue (reference to HrisEmployee)
action_idsstring[]NoLinked QmsAction IDs
change_idsstring[]NoLinked PlmChange IDs, when the same vendor also provides PLM
opened_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
due_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
closed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
file_idsstring[]NoAttachment IDs retrievable from StorageFile
urlstringNoDeep link to the vendor UI
metadataQmsMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe integration's API name (key) of an existing custom field.
metadata[].valueobjectNoThe field's value, typed by format.
metadata[].namespacestringNo
metadata[].formatenumNoThe data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/qms/5de520f96e439b002043d8dc/issue/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?