Create a work item for a task
/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskWorkItems
Request
-
ProjectId(required): integer(int64)
Unique identifier of the project.
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
SourceWorkItemId: integer
(int64)
Title:
Source Work Item ID
The unique identifier of the associated work item in the source application. -
TaskCompletionEvent: string
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. -
TaskCompletionEventCode: string
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. -
TaskId: integer
(int64)
Title:
Task ID
The unique identifier of the task. -
TaskName: string
Title:
Task Name
The name of the task. -
TaskNumber: string
The number of a task that is unique within the project.
-
Type: string
Title:
Type
The name of the work item type. -
TypeId: integer
(int64)
Title:
Type ID
The unique identifier of the work item type. -
WorkItemName: string
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. -
WorkItemRevision: string
Title:
Work Item Revision
The revision of the associated work item in the source application.
Response
- application/json
Default Response
-
Metadata-Context(required):
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(required):
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.
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectAssociationId: integer
(int64)
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. -
SourceWorkItemId: integer
(int64)
Title:
Source Work Item ID
The unique identifier of the associated work item in the source application. -
TaskCompletionEvent: string
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. -
TaskCompletionEventCode: string
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. -
TaskCompletionEventStatus: string
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. -
TaskCompletionEventStatusCode: string
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. -
TaskId: integer
(int64)
Title:
Task ID
The unique identifier of the task. -
TaskName: string
Title:
Task Name
The name of the task. -
TaskNumber: string
The number of a task that is unique within the project.
-
Type: string
Title:
Type
The name of the work item type. -
TypeId: integer
(int64)
Title:
Type ID
The unique identifier of the work item type. -
WorkItemCurrentStatus: string
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. -
WorkItemCurrentStatusCode: string
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. -
WorkItemName: string
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. -
WorkItemRevision: string
Title:
Work Item Revision
The revision of the associated work item in the source application.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to create a work item for a task by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185452480/child/TaskWorkItems
Example 1 Request Body
The following shows an example of the request body, to create a Negotiation work item, in JSON format.
{ "TaskId": 300100185814444, "TaskName": "Financial task 1", "TaskNumber": "361964", "TypeId": 7, "Type": "Negotiation", "SourceWorkItemId": 300100071607289, "WorkItemName": "zOTBI_R13_Service_001", "TaskCompletionEventCode": "COLLABORATION_TEAM_DEFINED", "TaskCompletionEvent": "Collaboration team defined" }
Example 1 Response Body
The following shows an example of the response body in JSON format.
{ "ObjectAssociationId": 300100185814451, "TaskId": 300100185814444, "TaskName": "Financial task 1", "TaskNumber": "361964", "TypeId": 7, "Type": "Negotiation", "SourceWorkItemId": 300100071607289, "WorkItemName": "zOTBI_R13_Service_001", "WorkItemRevision": "", "WorkItemCurrentStatusCode": "DRAFT", "WorkItemCurrentStatus": "Draft", "TaskCompletionEventCode": "COLLABORATION_TEAM_DEFINED", "TaskCompletionEvent": "Collaboration team defined", "TaskCompletionEventStatusCode": "ORA_PENDING", "TaskCompletionEventStatus": "Pending", "CreatedBy": "Connor.Horton", "CreationDate": "2020-05-22T05:28:15+00:00", "LastUpdatedBy": "Connor.Horton", "LastUpdateDate": "2020-05-22T05:28:15.383+00:00", "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185452480/child/TaskWorkItems/300100185814451", "name": "TaskWorkItems", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185452480/child/TaskWorkItems/300100185814451", "name": "TaskWorkItems", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185452480", "name": "projectPlans", "kind": "item" } ] }
Example 2 Request Body
The following shows an example of the request body, to create a Change Order work item, in JSON format
{ "TaskId": 300100185814444, "TaskName": "Financial task 1", "TaskNumber": "361964", "TypeId": 5, "Type": "Product Change Order", "SourceWorkItemId": 100000013609499, "WorkItemName": "zBIA_NIR10", "TaskCompletionEventCode": "4", "TaskCompletionEvent": "Scheduled" }
Example 2 Response Body
The following shows an example of the response body in JSON format.
{ "ObjectAssociationId": 300100185814453, "TaskId": 300100185814444, "TaskName": "Financial task 1", "TaskNumber": "361964", "TypeId": 5, "Type": "Product Change Order", "SourceWorkItemId": 100000013609499, "WorkItemName": "zBIA_NIR10", "WorkItemRevision": "", "WorkItemCurrentStatusCode": "1", "WorkItemCurrentStatus": "Open", "TaskCompletionEventCode": "4", "TaskCompletionEvent": "Scheduled", "TaskCompletionEventStatusCode": "ORA_PENDING", "TaskCompletionEventStatus": "Pending", "CreatedBy": "Connor.Horton", "CreationDate": "2020-05-22T05:32:30+00:00", "LastUpdatedBy": "Connor.Horton", "LastUpdateDate": "2020-05-22T05:32:30.123+00:00", "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185452480/child/TaskWorkItems/300100185814453", "name": "TaskWorkItems", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185452480/child/TaskWorkItems/300100185814453", "name": "TaskWorkItems", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185452480", "name": "projectPlans", "kind": "item" } ] }
Example 3 Request Body
The following shows an example of the request body, to create a Item work item, in JSON format.
{ "TaskId": 300100185814444, "TaskName": "Financial task 1", "TaskNumber": "361964", "TypeId": 6, "Type": "Item", "SourceWorkItemId": 100000013609382, "WorkItemName": "zBIA_CO_Item21", "WorkItemRevision": "B", "TaskCompletionEventCode": "Production", "TaskCompletionEvent": "Production" }
Example 3 Response Body
The following shows an example of the response body in JSON format.
{ "ObjectAssociationId": 300100185814452, "TaskId": 300100185814444, "TaskName": "Financial task 1", "TaskNumber": "361964", "TypeId": 6, "Type": "Item", "SourceWorkItemId": 100000013609382, "WorkItemName": "zBIA_CO_Item21", "WorkItemRevision": "B", "WorkItemCurrentStatusCode": "Design", "WorkItemCurrentStatus": "Design", "TaskCompletionEventCode": "Production", "TaskCompletionEvent": "Production", "TaskCompletionEventStatusCode": "ORA_PENDING", "TaskCompletionEventStatus": "Pending", "CreatedBy": "Connor.Horton", "CreationDate": "2020-05-22T05:30:16+00:00", "LastUpdatedBy": "Connor.Horton", "LastUpdateDate": "2020-05-22T05:30:16.158+00:00", "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185452480/child/TaskWorkItems/300100185814452", "name": "TaskWorkItems", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185452480/child/TaskWorkItems/300100185814452", "name": "TaskWorkItems", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185452480", "name": "projectPlans", "kind": "item" } ] }