Update a task status
patch
/fscmRestApi/resources/11.13.18.05/recallTaskHistory/{ActionId}
Request
Path Parameters
-
ActionId(required): integer(int64)
Value that uniquely identifies task assignment at product recall traceability header level or disposition organization level.
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-
AttachmentEntityName: string
Default Value:
RECALL_TASK_HISTORY -
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
Comments: string
Maximum Length:
2000Comments on completion of task or withdrawal of a task. -
ObjectVersionNumber: integer
(int32)
Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
-
TaskStatus: string
Title:
Task StatusMaximum Length:80Status of the task. -
TaskStatusCode: string
Title:
Task StatusMaximum Length:30Abbreviation that identifies the task status assigned to the product traceability header and disposition organization level. -
WithdrawEligibleFlag: boolean
Maximum Length:
80Contains one of the following values: true or false. If true, then the task is eligible for withdrawal. If false, then the task is not eligible for withdrawal. The value is derived, so does not have a default value.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : recallTaskHistory-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.
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 : recallTaskHistory-item-response
Type:
Show Source
object-
ActionId: integer
(int64)
Value that uniquely identifies task assignment at product recall traceability header level or disposition organization level.
-
AttachmentEntityName: string
Default Value:
RECALL_TASK_HISTORY -
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
Comments: string
Maximum Length:
2000Comments on completion of task or withdrawal of a task. -
CompletionDate: string
(date)
Title:
Completion DateDate when the task assigned is completed. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
DispositionOrganizationCode: string
Title:
Inventory OrganizationRead Only:trueMaximum Length:18Abbreviation that identifies the disposition organization. -
DispositionOrganizationId: integer
(int64)
Value that uniquely identifies disposition organization.
-
DispositionOrganizationName: string
Read Only:
trueMaximum Length:240Name of disposition organization. -
EstimatedQuantity: number
Read Only:
trueEstimated quantity to be recalled. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login that the user used when updating the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManufacturerPartNumber: string
Title:
Manufacturer Part NumberRead Only:trueMaximum Length:700Number that identifies the part recalled by the manufacturer for which traceability is performed. -
NotifiedFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the notification has been sent to the user for the task assigned at the product traceability header and disposition organization level. If false, then the notification has not been sent to the user for the task assigned at the product traceability header and/or disposition organization level. The default value is false, until the locate program is run. -
ObjectVersionNumber: integer
(int32)
Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
-
OrganizationCode: string
Title:
Inventory OrganizationRead Only:trueMaximum Length:255Abbreviation that identifies the inventory organization or the disposition organization. -
OrganizationId: integer
Read Only:
trueValue that uniquely identifies the inventory organization or the disposition organization. -
OrganizationName: string
Read Only:
trueMaximum Length:255Name of the inventory organization or the disposition organization. -
ProductTraceId: integer
(int64)
Value that uniquely identifies product traceability header.
-
ProductTraceStatus: string
Title:
Traceability StatusRead Only:trueMaximum Length:80Status of the product traceability of a recalled product. -
ProductTraceStatusCode: string
Title:
Traceability StatusRead Only:trueMaximum Length:30Abbreviation that identifies the product traceability status of a recalled product. -
ProductTraceStatusInventoryItemDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:255Description of the inventory item. -
ProductTraceStatusInventoryItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies inventory Item. -
ProductTraceStatusInventoryItemNumber: string
Title:
ItemRead Only:trueMaximum Length:300Number that identifies the item. -
ProductTraceStatusLocationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the deliver to location. -
ProductTraceStatusLocationName: string
Title:
LocationRead Only:trueMaximum Length:240Name of deliver to location. -
ProductTraceStatusOrganizationCode: string
Read Only:
trueMaximum Length:18Abbreviation that identifies the inventory organization. -
ProductTraceStatusOrganizationId: integer
(int64)
Read Only:
trueValue that uniquely identifies inventory organization. -
ProductTraceStatusOrganizationName: string
Read Only:
trueMaximum Length:240Name of the inventory organization. -
ProductTraceStatusRequesterId: integer
(int64)
Read Only:
trueValue that uniquely identifies the requester, to whom recalled parts have been issued. -
ProductTraceStatusRequesterName: string
Title:
RequesterRead Only:trueMaximum Length:240Name of the requester. -
ProductTraceStatusSubinventory: string
Title:
SubinventoryRead Only:trueMaximum Length:60Name of the subinventory where the recalled parts reside. -
RecallLineId: integer
(int64)
Value that uniquely identifies recall notice line.
-
RecallLineNumber: integer
(int64)
Title:
Line NumberRead Only:trueNumber that identifies the recall notice line. -
RecallNoticeId: integer
(int64)
Title:
Header IDRead Only:trueValue that uniquely identifies recall notice. -
RecallNoticeNumber: string
Title:
Notice NumberRead Only:trueMaximum Length:60Number that identifies the recall notice used for internal tracking within a business unit, which gets generated based on recall document number sequence setup. -
StartDate: string
(date)
Title:
Start DateDate when the task is assigned. -
TaskCode: string
Read Only:
trueMaximum Length:60Abbreviation that identifies the task. -
TaskId: integer
(int64)
Value that uniquely identifies task.
-
TaskName: string
Title:
Task NameRead Only:trueMaximum Length:60Name of the task. -
TaskStatus: string
Title:
Task StatusMaximum Length:80Status of the task. -
TaskStatusCode: string
Title:
Task StatusMaximum Length:30Abbreviation that identifies the task status assigned to the product traceability header and disposition organization level. -
VendorProductNumber: string
Read Only:
trueMaximum Length:300Supplier part number. -
WithdrawEligibleFlag: boolean
Maximum Length:
80Contains one of the following values: true or false. If true, then the task is eligible for withdrawal. If false, then the task is not eligible for withdrawal. The value is derived, so does not have a default value.
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 : recallTaskHistory-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 : 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.
Links
- attachments
-
Parameters:
- ActionId:
$request.path.ActionId
The attachments resource is used to view, create, and update attachments. - ActionId:
Examples
This example describes how to update a task status.
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/recallTaskHistory/ActionId"
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.
{
"TaskStatus": "Completed"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"ActionId": 100100189508804,
"RecallLineId": 300100211076446,
"RecallLineNumber": 1,
"RecallNoticeId": 300100211076445,
"RecallNoticeNumber": "RND1157",
"ProductTraceId": 100100189508795,
"ProductTraceStatusOrganizationId": 300100200296143,
"ProductTraceStatusOrganizationCode": "HC01",
"ProductTraceStatusOrganizationName": "Vision General Hospital",
"ProductTraceStatusLocationId": null,
"ProductTraceStatusLocationName": null,
"ProductTraceStatusSubinventory": null,
"ProductTraceStatusRequesterId": null,
"ProductTraceStatusRequesterName": null,
"ProductTraceStatusInventoryItemId": 300100203603610,
"ProductTraceStatusInventoryItemNumber": "SCH1002",
"ProductTraceStatusInventoryItemDescription": "Implantable Pacemaker Pulse-Generator",
"ProductTraceStatusCode": "ORA_INBOUND",
"ProductTraceStatus": "Inbound",
"DispositionOrganizationId": null,
"DispositionOrganizationCode": null,
"DispositionOrganizationName": null,
"TaskId": 300100207304020,
"TaskCode": "ORA_DELIVER",
"TaskName": "Deliver Recalled Parts to Quarantine Location",
"NotifiedFlag": null,
"TaskStatusCode": "ORA_COMPLETED",
"TaskStatus": "Completed",
"StartDate": "2020-08-19",
"CompletionDate": "2020-08-20",
"ObjectVersionNumber": 2,
"CreationDate": "2020-08-19T04:24:23+00:00",
"CreatedBy": "User1",
"LastUpdateDate": "2020-08-20T05:54:05+00:00",
"LastUpdatedBy": "User1",
"LastUpdateLogin": "ACDD42AC6CCA38C0E053CC5AF00AA1CA",
"ManufacturerPartNumber": "MFG1002",
"EstimatedQuantity": 0,
"OrganizationId": 300100200296143,
"OrganizationCode": "HC01",
"OrganizationName": "Vision General Hospital",
"WithdrawEligibleFlag": false,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/recallTaskHistory/100100189508804",
"name": "recallTaskHistory",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/recallTaskHistory/100100189508804",
"name": "recallTaskHistory",
"kind": "item"
}
]
}