Get one issue
get
/fscmRestApi/resources/11.13.18.05/qualityIssues/{IssueId}
Request
Path Parameters
-
IssueId(required): integer(int64)
Value that uniquely identifies the quality issue.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : qualityIssues-item-response
Type:
Show Source
object
-
AffectedObjects: array
Affected Objects
Title:
Affected Objects
The Affected Objects resource manages an item, inspection, work order operation, or some other object in manufacturing or inspection that caused a quality issue or that a quality issue affects. -
AssignedTo: string
Title:
Assigned To
Maximum Length:64
User who the application assigned to manage the quality issue. -
Attachments: array
Attachments
Title:
Attachments
The Attachments resource manages details about the quality issue or document and how the application resolved the quality issue. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the quality issue. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the quality issue. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer that this quality issue affects.
-
CustomerName: string
Read Only:
true
Name of the customer. -
Description: string
(byte)
Title:
Description
Long description of the quality issue. You cannot use the POST method to add a value for this attribute. You should use the PATCH method instead. -
Disposition: string
Title:
Disposition
Maximum Length:30
Proposed disposition of the quality issue. -
DispositionComment: string
Title:
Disposition Comment
Maximum Length:4000
Text that describes how the application resolved the quality issue. -
DispositionName: string
Read Only:
true
Name of the disposition. -
Downtime: integer
(int64)
Title:
Downtime
Expected downtime in manufacturing because of the quality issue. -
ExpectedResolutionDate: string
(date-time)
Title:
Expected Resolution Date
Date when the quality issue must resolve. -
IssueId: integer
(int64)
Title:
Issue
Read Only:true
Value that uniquely identifies the quality issue. -
IssueNumber: string
Title:
Number
Maximum Length:100
Number that identifies the quality issue. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date when the user most recently updated the quality issue. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the quality issue. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:400
Short name of the quality issue. -
OrganizationCode: string
Abbreviation that identifies the organization where the quality issue occurred.
-
OrganizationId: integer
(int64)
Title:
Organization
Value that uniquely identifies the organization where the quality issue occurred. -
OrganizationName: string
Title:
Organization
Read Only:true
Name of the organization. -
QualityTypeCode: string
Abbreviation that identifies the type of quality issue.
-
QualityTypeId: integer
(int64)
Title:
Type
Value that uniquely identifies the type of quality issue. -
QualityTypeName: string
Title:
Type
Read Only:true
Name of the quality type. -
Relationships: array
Relationships
Title:
Relationships
The Relationships resource manages the objects related to a quality issue. The objects reference a quality issue, an item, or other objects. -
ReportedBy: string
Title:
Reported By
Maximum Length:64
User who reported the quality issue. -
ReportedDate: string
(date-time)
Title:
Reported Date
Date when the user reported the quality issue. -
Security: array
Security Grantees
Title:
Security Grantees
The Security Grantees resource manages the security grantees who have access to the quality issue. -
Severity: string
Title:
Severity
Maximum Length:30
Severity of the quality issue. -
SeverityName: string
Read Only:
true
Name of the severity. -
Source: string
Title:
Source
Maximum Length:30
Source or location where the quality issue occurred. -
SourceName: string
Read Only:
true
Name of the source. -
StatusTypeId: integer
(int64)
Read Only:
true
Internal value that uniquely identifies the quality issue's status type. -
StatusTypeName: string
Read Only:
true
Display name of the type of status of the quality issue. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier who supplied the item that the quality issue affects.
-
SupplierName: string
Read Only:
true
Name of the supplier. -
TextDescription: string
Plain text description of the quality issue.
-
WorkflowApprovers: array
Workflow Approvers
Title:
Workflow Approvers
The Workflow Approvers resource manages the workflow approvers. -
WorkflowStatusCode: string
Abbreviation that identifies the workflow status of the quality issue.
-
WorkflowStatusId: integer
(int64)
Title:
Workflow Status
Value that uniquely identifies the workflow status. -
WorkflowStatusName: string
Title:
Status
Read Only:true
Name of the workflow status. -
WorkflowTemplateCode: string
Abbreviation that identifies the workflow template.
-
WorkflowTemplateId: integer
Value that uniquely identifies the workflow template.
-
WorkflowTemplateName: string
Title:
Workflow
Read Only:true
Maximum Length:80
Name of the workflow template.
Nested Schema : Affected Objects
Type:
array
Title:
Affected Objects
The Affected Objects resource manages an item, inspection, work order operation, or some other object in manufacturing or inspection that caused a quality issue or that a quality issue affects.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource manages details about the quality issue or document and how the application resolved the quality issue.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The Relationships resource manages the objects related to a quality issue. The objects reference a quality issue, an item, or other objects.
Show Source
Nested Schema : Security Grantees
Type:
array
Title:
Security Grantees
The Security Grantees resource manages the security grantees who have access to the quality issue.
Show Source
Nested Schema : Workflow Approvers
Type:
array
Title:
Workflow Approvers
The Workflow Approvers resource manages the workflow approvers.
Show Source
Nested Schema : qualityIssues-AffectedObjects-item-response
Type:
Show Source
object
-
AffectedObjectId: integer
(int64)
Title:
Affected Object
Value that uniquely identifies the item that the quality issue affects. -
ContextCode: string
Abbreviation that identifies the context of the item that the quality issue affects.
-
ContextId: integer
(int64)
Value that uniquely identifies the context of the item that the quality issue affects.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who added the item that the quality issue affects. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user added the item that the quality issue affects. -
Description: string
Title:
Description
Maximum Length:400
Description of the item that the quality issue affects. -
ImpactType: string
Title:
Impact Type
Maximum Length:30
Type of impact that the item that the quality issue affects causes. -
ImpactTypeName: string
Read Only:
true
Name of the impact type. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the item that the quality issue affects. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the item that the quality issue affects. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Title:
Object
Value that uniquely identifies the item that the quality issue affects. -
Status: string
Title:
Relation Status
Maximum Length:30
Status of the item that the quality issue affects. -
StatusName: string
Read Only:
true
Name of the status. -
SubContextCode: string
Abbreviation that identifies the subcontext of the affected object.
-
SubContextFiveId: string
Maximum Length:
80
Value that uniquely identifies the fifth subcontext of the affected object. -
SubContextFourId: integer
(int64)
Value that uniquely identifies the fourth subcontext of the affected object.
-
SubContextId: integer
(int64)
Value that uniquely identifies the subcontext of the affected object.
-
SubContextSixId: string
Maximum Length:
80
Value that uniquely identifies the sixth subcontext of the affected object. -
SubContextThreeId: integer
(int64)
Value that uniquely identifies the third subcontext of the affected object.
-
SubContextTwoCode: string
Abbreviation that identifies the second subcontext of the affected object.
-
SubContextTwoId: integer
(int64)
Value that uniquely identifies the second subcontext of the affected object.
-
SupportedEntityCode: string
Type of object that the quality issue affects.
-
SupportedEntityId: integer
(int64)
Value that uniquely identifies the supported entity of the item that the quality issue affects.
-
SupportedEntityName: string
Name of the supported entity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : qualityIssues-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment for the specification. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attached file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The Base64-encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the attached document. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who most recently updated the attached document. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the attachment for the specification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : qualityIssues-Relationships-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the relationship. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the relationship. -
Description: string
Description of the related object.
-
DestObjId: integer
(int64)
Value that uniquely identifies the destination object.
-
DestObjType: string
Maximum Length:
30
Type of the destination object. -
DestObjTypeName: string
Read Only:
true
Name of the destination object type. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the relationship. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the relationship. -
LatestFlag: boolean
Contains one of the following values: true or false. If true, then the related object is the latest. If false, then the related object is not the latest. This attribute does not have a default value.
-
LatestFlagName: string
Read Only:
true
Name of the latest flag. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Name of the related object.
-
RelationshipId: integer
(int64)
Read Only:
true
Value that uniquely identifies the relationship. -
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
Type of relationship. -
RelationshipTypeName: string
Read Only:
true
Name of the relationship type. -
SrcObjId: integer
(int64)
Value that uniquely identifies the source object.
-
SrcObjType: string
Maximum Length:
30
Type of the source object. -
Status: string
Status of the related object.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : qualityIssues-Security-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the security grantee. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the security grantee. -
GranteeName: string
Maximum Length:
256
Name of the security grantee. -
GranteeType: string
Title:
Principal
Maximum Length:30
Type of the security grantee. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the security grantee. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the security grantee. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : qualityIssues-WorkflowApprovers-item-response
Type:
Show Source
object
-
ActivityType: string
Type of the workflow approval activity.
-
AssigneeName: string
Name of the workflow approval assignee.
-
AssigneeType: string
Type of the workflow approval assignee.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WfRoutePeopleId: integer
(int64)
Value that uniquely identifies the workflow approver.
-
WorkflowStatusCode: string
Abbreviation that identifies the workflow approval status.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AffectedObjects
-
Parameters:
- IssueId:
$request.path.IssueId
The Affected Objects resource manages an item, inspection, work order operation, or some other object in manufacturing or inspection that caused a quality issue or that a quality issue affects. - IssueId:
- Attachments
-
Parameters:
- IssueId:
$request.path.IssueId
The Attachments resource manages details about the quality issue or document and how the application resolved the quality issue. - IssueId:
- Relationships
-
Parameters:
- IssueId:
$request.path.IssueId
The Relationships resource manages the objects related to a quality issue. The objects reference a quality issue, an item, or other objects. - IssueId:
- Security
-
Parameters:
- IssueId:
$request.path.IssueId
The Security Grantees resource manages the security grantees who have access to the quality issue. - IssueId:
- WorkflowApprovers
-
Parameters:
- IssueId:
$request.path.IssueId
The Workflow Approvers resource manages the workflow approvers. - IssueId:
Examples
This example describes how to get one cost adjustment.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/qualityIssues/IssueId"
For example, the following command gets one cost adjustment:
curl -u username:password "https://servername/fscmRestApi/resources/version/costAdjustments/4011"
Example Response Body
The following shows an example of the response body in JSON format.
{ "IssueId": 300100255139585, "IssueNumber": "54", "Name": "Issue XYZ", "QualityTypeId": 1278, "QualityTypeCode": "ORA_ENQ_MNT_RESOURCE", "QualityTypeName": "Maintenance - Resource", "Severity": "ORA_HIGH", "SeverityName": "High", "Downtime": null, "Source": "ORA_MAINTENANCE", "SourceName": "Maintenance", "OrganizationId": 204, "OrganizationCode": "V1", "OrganizationName": "Vision Operations", "CustomerId": null, "SupplierId": null, "Disposition": null, "DispositionName": null, "DispositionComment": null, "CreationDate": "2020-09-17T08:47:04+00:00", "LastUpdateDate": "2020-09-17T08:47:06.065+00:00", "ExpectedResolutionDate": null, "WorkflowStatusId": 101, "WorkflowStatusCode": "ORA_ISSUE_EXCEP_OPEN", "WorkflowStatusName": "Open", "WorkflowTemplateId": 2008, "WorkflowTemplateCode": null, "WorkflowTemplateName": null, "CreatedBy": "QUALITY_ANALYST", "AssignedTo": null, "ReportedDate": null, "ReportedBy": null, "LastUpdatedBy": "QUALITY_ANALYST", "IssueEO_QI_DCL_QA_Id_c": null, "IssueEO_QI_DCL_QA_c": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/qualityIssues/300100255139585", "name": "qualityIssues", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/qualityIssues/300100255139585", "name": "qualityIssues", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/qualityIssues/300100255139585/child/AffectedObjects", "name": "AffectedObjects", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/qualityIssues/300100255139585/child/Attachments", "name": "Attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/qualityIssues/300100255139585/child/Relationships", "name": "Relationships", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/qualityIssues/300100255139585/child/WorkflowApprovers", "name": "WorkflowApprovers", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/qualityIssues/300100255139585/enclosure/Description", "name": "Description", "kind": "other" } ] }