Update a work item for a task

patch

/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskWorkItems/{ObjectAssociationId}

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
  • Title: Task Completion Event Code
    Maximum Length: 30
    The code that represents the associated work item event or status change in the source application required to automatically mark the project task as complete.
  • Title: Task Name
    The name of the task.
  • Title: Type ID
    The unique identifier of the work item type.
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 : projectPlans-TaskWorkItems-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Links
  • Title: Object Association ID
    Read Only: true
    The unique identifier of the association of two business objects. For example, an identifier of the association between a work item and a project task.
  • Title: Source Work Item ID
    The unique identifier of the associated work item in the source application.
  • Title: Task Completion Event
    The associated work item event or status change required in the source application to automatically mark the project task as complete. For example, approved, production, and suppliers invited. A list of values is defined in the lookup type for each work item type.
  • Title: Task Completion Event Code
    Maximum Length: 30
    The code that represents the associated work item event or status change in the source application required to automatically mark the project task as complete.
  • Title: Task Completion Event Status
    Read Only: true
    Maximum Length: 80
    The status that indicates whether the task completion event is pending, completed, or not set. The list of values is defined in the lookup ORA_PJE_COMPLETION_RULE_STATUS. The list of values can be accessed using the Setup and Maintenance work area and the Manage Standard Lookups task.
  • Title: Task Completion Event Status Code
    Read Only: true
    Maximum Length: 30
    The code that represents whether the task completion event is pending, completed, or that no completion rule is set. Valid values are ORA_PENDING, ORA_COMPLETE, and ORA_NOT_SET. The list of values is defined in the lookup ORA_PJE_COMPLETION_RULE_STATUS. The list of values can be accessed using the Setup and Maintenance work area and the Manage Standard Lookups task.
  • Title: Task ID
    The unique identifier of the task.
  • Title: Task Name
    The name of the task.
  • The number of a task that is unique within the project.
  • Title: Type
    The name of the work item type.
  • Title: Type ID
    The unique identifier of the work item type.
  • Title: Work Item Current Status
    Read Only: true
    The current status of the associated work item in the source application. For example, draft, prototype, or design.
  • Title: Work Item Current Status Code
    Read Only: true
    The code that represents the current status of the associated work item in the source application.
  • Title: Work Item Name
    The name or unique identifier of the associated work item in the source application. When using POST, you must enter the document number for Negotiation and the name for all other work item types.
  • Title: Work Item Revision
    The revision of the associated work item in the source application.
Back to Top

Examples

The following example shows how to update a work item for a task by submitting a PATCH request on the REST resource using cURL.

curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100186215387/child/TaskWorkItems/300100186224395

Request Body Example

The following shows an example of the request body in JSON format.

{
  "TaskCompletionEventCode": "AWARD_COMPLETED"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
      "ObjectAssociationId": 300100186224395,
      "TaskName": "Analyze Supplier Responses",
      "TaskId": 100100127909071,
      "TypeId": 7,
      "Type": "Negotiation",
      "SourceWorkItemId": 300100074914877,
      "WorkItemName": "Supplier Qualification Requirements",
      "WorkItemRevision": "",
      "WorkItemCurrentStatusCode": "DRAFT",
      "WorkItemCurrentStatus": "Draft",
     "TaskCompletionEventCode": "AWARD_COMPLETED",
     "TaskCompletionEvent": "Award completed",
      "TaskCompletionEventStatusCode": "ORA_PENDING",
      "TaskCompletionEventStatus": "Pending",
      "CreatedBy": "ABRAHAM.MASON",
      "CreationDate": "2019-11-22T14:41:39+00:00",
      "LastUpdatedBy": "ABRAHAM.MASON",
      "LastUpdateDate": "2019-11-22T15:10:36+00:00",
      "links": [
        {
          ....
        }
      ]
}
Back to Top