Update a task status

patch

/fscmRestApi/resources/11.13.18.05/recallTaskHistory/{ActionId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Default Value: RECALL_TASK_HISTORY
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Maximum Length: 2000
    Comments on completion of task or withdrawal of a task.
  • 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.
  • Title: Task Status
    Maximum Length: 80
    Status of the task.
  • Title: Task Status
    Maximum Length: 30
    Abbreviation that identifies the task status assigned to the product traceability header and disposition organization level.
  • Maximum Length: 80
    Contains 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: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : recallTaskHistory-attachments-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : recallTaskHistory-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : recallTaskHistory-attachments-item-response
Type: object
Show Source
Back to Top

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"
	}
	]
}
Back to Top