Update a task
patch
/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/tasks/{TaskId}
Request
Path Parameters
-
ChangeId(required): integer
Value that uniquely identifies the change.
-
TaskId(required): integer(int64)
Value that uniquely identifies the task in the change object.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AssignedTo: string
User to whom the change object is assigned.
-
CompleteBeforeStatusCode: integer
(int64)
Abbreviation that identifies the change object status before by which the task should be marked as completed.
-
Description: string
Maximum Length:
2000
Description of the task in the change object. -
Name: string
Maximum Length:
240
Name of the task. -
NeedByDate: string
(date-time)
Date when the change is expected to be completed.
-
RequiredFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the task is required to be completed prior to the complete before status. If false, then the task is not required to be completed prior to any status. The default value is false. -
SequenceNumber: integer
Sequence number of the task in the change object. Each task must have a unique sequence number within the change object.
-
StartAfterStatusCode: integer
(int64)
Abbreviation that identifies the change object status after which the task can be marked as completed.
-
StatusCode: integer
(int64)
Abbreviation that identifies the status of the task. Valid values are Open, Completed, and Canceled. If this attribute value is Completed or Canceled, only this attribute can be updated. All other attributes are not editable.
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 : productChangeOrders-tasks-item-response
Type:
Show Source
object
-
AssignedTo: string
User to whom the change object is assigned.
-
CompleteBeforeStatusCode: integer
(int64)
Abbreviation that identifies the change object status before by which the task should be marked as completed.
-
Description: string
Maximum Length:
2000
Description of the task in the change object. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
240
Name of the task. -
NeedByDate: string
(date-time)
Date when the change is expected to be completed.
-
RequiredFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the task is required to be completed prior to the complete before status. If false, then the task is not required to be completed prior to any status. The default value is false. -
SequenceNumber: integer
Sequence number of the task in the change object. Each task must have a unique sequence number within the change object.
-
StartAfterStatusCode: integer
(int64)
Abbreviation that identifies the change object status after which the task can be marked as completed.
-
StatusCode: integer
(int64)
Abbreviation that identifies the status of the task. Valid values are Open, Completed, and Canceled. If this attribute value is Completed or Canceled, only this attribute can be updated. All other attributes are not editable.
-
TaskId: integer
(int64)
Read Only:
true
Value that uniquely identifies the task in the change object.
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.
Examples
This example describes how to patch one task.
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/productChangeOrders/ChangeId/child/tasks/TaskId"
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.
{ "Name": "task_002_1", "Description": "task_002 update", "StartAfterStatusCode": 8, "CompleteBeforeStatusCode": 4 }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "TaskId": 300100171978567, "SequenceNumber": 20, "Name": "task_002_1", "Description": "task_002 update", "RequiredFlag": null, "AssignedTo": null, "StartAfterStatusCode": 8, "CompleteBeforeStatusCode": 4, "NeedByDate": null, "StatusCode": 1, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100171975721/child/tasks/300100171978567", "name": "tasks", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100171975721/child/tasks/300100171978567", "name": "tasks", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100171975721", "name": "productChangeOrders", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100171975721/child/tasks/300100171978567/lov/TaskStatusesPVO", "name": "TaskStatusesPVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100171975721/child/tasks/300100171978567/lov/UserPVO1", "name": "UserPVO1", "kind": "collection" } ] }