Update an issue
patch
/fscmRestApi/resources/11.13.18.05/qualityIssues/{IssueId}
Request
Path Parameters
-
IssueId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context: string
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: string
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AffectedObjects: array
AffectedObjects
-
AssignedTo: string
Title:
Assigned ToMaximum Length:64 -
Attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CustomerId: integer
(int64)
-
Description: string
(byte)
Title:
Description -
Disposition: string
Title:
DispositionMaximum Length:30 -
DispositionComment: string
Title:
Disposition CommentMaximum Length:4000 -
Downtime: integer
(int64)
Title:
Downtime -
ExpectedResolutionDate: string
(date-time)
Title:
Expected Resolution Date -
Name: string
Title:
NameMaximum Length:400 -
QualityTypeId: integer
(int64)
Title:
Type -
Relationships: array
Relationships
-
ReportedBy: string
Title:
Reported ByMaximum Length:64 -
ReportedDate: string
(date-time)
Title:
Reported Date -
Security: array
Security
-
Severity: string
Title:
SeverityMaximum Length:30 -
Source: string
Title:
SourceMaximum Length:30 -
SupplierId: integer
(int64)
-
TextDescription: string
-
WorkflowApprovers: array
WorkflowApprovers
-
WorkflowStatusCode: string
-
WorkflowStatusId: integer
(int64)
Title:
Workflow Status -
WorkflowTemplateCode: string
-
WorkflowTemplateId: integer
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : qualityIssues-AffectedObjects-item-patch-request
Type:
Show Source
object-
ContextCode: string
-
ImpactType: string
Title:
Impact TypeMaximum Length:30 -
Status: string
Title:
Relation StatusMaximum Length:30 -
SubContextCode: string
-
SubContextTwoCode: string
-
SupportedEntityCode: string
-
SupportedEntityName: string
Nested Schema : qualityIssues-Attachments-item-patch-request
Type:
Show Source
object-
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
Nested Schema : schema
Type:
Show Source
object-
Description: string
-
DestObjId: integer
(int64)
-
DestObjType: string
Maximum Length:
30 -
LatestFlag: boolean
-
Name: string
-
RelationshipType: string
Title:
Relationship TypeMaximum Length:30 -
SrcObjId: integer
(int64)
-
SrcObjType: string
Maximum Length:
30 -
Status: string
Nested Schema : qualityIssues-Security-item-patch-request
Type:
Show Source
object-
GranteeType: string
Title:
PrincipalMaximum Length:30
Response
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
AffectedObjects
-
AssignedTo: string
Title:
Assigned ToMaximum Length:64 -
AssignedUser: string
Read Only:
true -
Attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64 -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:true -
CustomerId: integer
(int64)
-
CustomerName: string
Read Only:
true -
Description: string
(byte)
Title:
Description -
Disposition: string
Title:
DispositionMaximum Length:30 -
DispositionComment: string
Title:
Disposition CommentMaximum Length:4000 -
DispositionName: string
Read Only:
true -
Downtime: integer
(int64)
Title:
Downtime -
ExpectedResolutionDate: string
(date-time)
Title:
Expected Resolution Date -
IssueId: integer
(int64)
Title:
IssueRead Only:true -
IssueNumber: string
Title:
NumberMaximum Length:100 -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:true -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
NameMaximum Length:400 -
OrganizationCode: string
-
OrganizationId: integer
(int64)
Title:
Organization -
OrganizationName: string
Title:
OrganizationRead Only:true -
QualityTypeCode: string
-
QualityTypeId: integer
(int64)
Title:
Type -
QualityTypeName: string
Title:
TypeRead Only:true -
Relationships: array
Relationships
-
ReportedBy: string
Title:
Reported ByMaximum Length:64 -
ReportedDate: string
(date-time)
Title:
Reported Date -
Security: array
Security
-
Severity: string
Title:
SeverityMaximum Length:30 -
SeverityName: string
Read Only:
true -
Source: string
Title:
SourceMaximum Length:30 -
SourceName: string
Read Only:
true -
StatusTypeId: integer
(int64)
Read Only:
true -
StatusTypeName: string
Read Only:
true -
SupplierId: integer
(int64)
-
SupplierName: string
Read Only:
true -
TextDescription: string
-
WorkflowApprovers: array
WorkflowApprovers
-
WorkflowStatusCode: string
-
WorkflowStatusId: integer
(int64)
Title:
Workflow Status -
WorkflowStatusName: string
Title:
StatusRead Only:true -
WorkflowTemplateCode: string
-
WorkflowTemplateId: integer
-
WorkflowTemplateName: string
Title:
WorkflowRead Only:trueMaximum Length:80
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : qualityIssues-AffectedObjects-item-response
Type:
Show Source
object-
AffectedObjectId: integer
(int64)
Title:
Affected Object -
ContextCode: string
-
ContextId: integer
(int64)
-
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
Description: string
Title:
DescriptionMaximum Length:400 -
ImpactType: string
Title:
Impact TypeMaximum Length:30 -
ImpactTypeName: string
Read Only:
true -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectId: integer
(int64)
Title:
Object -
Status: string
Title:
Relation StatusMaximum Length:30 -
StatusName: string
Read Only:
true -
SubContextCode: string
-
SubContextFiveId: string
Maximum Length:
80 -
SubContextFourId: integer
(int64)
-
SubContextId: integer
(int64)
-
SubContextSixId: string
Maximum Length:
80 -
SubContextThreeId: integer
(int64)
-
SubContextTwoCode: string
-
SubContextTwoId: integer
(int64)
-
SupportedEntityCode: string
-
SupportedEntityId: integer
(int64)
-
SupportedEntityName: string
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : qualityIssues-Relationships-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
Description: string
-
DestObjId: integer
(int64)
-
DestObjType: string
Maximum Length:
30 -
DestObjTypeName: string
Read Only:
true -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
LatestFlag: boolean
-
LatestFlagName: string
Read Only:
true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
-
RelationshipId: integer
(int64)
Read Only:
true -
RelationshipType: string
Title:
Relationship TypeMaximum Length:30 -
RelationshipTypeName: string
Read Only:
true -
SrcObjId: integer
(int64)
-
SrcObjType: string
Maximum Length:
30 -
Status: string
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : qualityIssues-Security-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
GranteeName: string
Maximum Length:
256 -
GranteeType: string
Title:
PrincipalMaximum Length:30 -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : qualityIssues-WorkflowApprovers-item-response
Type:
Show Source
object-
ActivityType: string
-
AssigneeName: string
-
AssigneeType: string
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
WfRoutePeopleId: integer
(int64)
-
WorkflowStatusCode: string
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- AffectedObjects
-
Parameters:
- IssueId:
$request.path.IssueId
- IssueId:
- Attachments
-
Parameters:
- IssueId:
$request.path.IssueId
- IssueId:
- Relationships
-
Parameters:
- IssueId:
$request.path.IssueId
- IssueId:
- Security
-
Parameters:
- IssueId:
$request.path.IssueId
- IssueId:
- WorkflowApprovers
-
Parameters:
- IssueId:
$request.path.IssueId
- IssueId:
Examples
This example describes how to update an issue.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/qualityIssues/IssueId"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{
"DispositionComment": "Test Data Update"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"IssueId": 300100255139880,
"IssueNumber": "ISSUE172",
"Name": "Issues XYZ",
"QualityTypeId": 1404,
"QualityTypeCode": "ORA_ENQ_QI_PR_ITEM",
"QualityTypeName": "Problem Report - Item",
"Severity": "ORA_HIGH",
"SeverityName": "High",
"Downtime": 20,
"Source": "ORA_QUALITY",
"SourceName": "Quality",
"OrganizationId": 204,
"OrganizationCode": "V1",
"OrganizationName": "Vision Operations",
"CustomerId": null,
"SupplierId": null,
"Disposition": null,
"DispositionName": null,
"DispositionComment": "Test Data Update",
"CreationDate": "2020-09-17T09:15:47+00:00",
"LastUpdateDate": "2020-09-17T09:23:32.052+00:00",
"ExpectedResolutionDate": null,
"WorkflowStatusId": 999,
"WorkflowStatusCode": "ORA_ENQ_DEFAULT_STATUS",
"WorkflowStatusName": "Default",
"WorkflowTemplateId": 2011,
"WorkflowTemplateCode": "ORA_ISSUE_WORKFLOW_WITH_PREAPPROVAL_AND_APPROVAL",
"WorkflowTemplateName": "Issue Workflow with Preapproval and Approval",
"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/300100255139880",
"name": "qualityIssues",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/qualityIssues/300100255139880",
"name": "qualityIssues",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/qualityIssues/300100255139880/child/AffectedObjects",
"name": "AffectedObjects",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/qualityIssues/300100255139880/child/Attachments",
"name": "Attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/qualityIssues/300100255139880/child/Relationships",
"name": "Relationships",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/qualityIssues/300100255139880/child/WorkflowApprovers",
"name": "WorkflowApprovers",
"kind": "collection"
},
{
"rel": "enclosure",
"href": "https://servername/fscmRestApi/resources/version/qualityIssues/300100255139880/enclosure/Description",
"name": "Description",
"kind": "other"
}
]
}