Get a work item for a task
get
/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskWorkItems/{ObjectAssociationId}
Request
Path Parameters
-
ObjectAssociationId(required): integer(int64)
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.
-
ProjectId(required): integer(int64)
Unique identifier of the project.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : projectPlans-TaskWorkItems-item-response
Type:
Show Source
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.
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
The following example shows how to get a work item for a task by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100186215387/child/TaskWorkItems/300100186224395
Response Body Example
The following shows an example of the response body in JSON format of the award funding sources.
{ "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": [ { .... } ] }