1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Project Plans
  4. Task Work Items

Get all work items for all the tasks of a project

get

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

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the task work item with the specified primary key.
      Finder Variables:
      • ObjectAssociationId; integer; Unique identifier of the task work item association.
    • findByObjectAssociationId: Finds the task work item with the specified task work item association identifier.
      Finder Variables:
      • ObjectAssociationId; integer; Unique identifier of the task work item association.
    • findByTaskId: Finds all work item associations for the specified task identifier.
      Finder Variables:
      • TaskId; integer; The unique identifier of the task.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdatedBy; string; The user who last updated the record.
    • ObjectAssociationId; integer; 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; The unique identifier of the associated work item in the source application.
    • TaskCompletionEvent; string; 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; 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; 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; 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; The unique identifier of the task.
    • TaskName; string; The name of the task.
    • TaskNumber; string; The number of a task that is unique within the project.
    • Type; string; The name of the work item type.
    • TypeId; integer; The unique identifier of the work item type.
    • WorkItemCurrentStatus; string; The current status of the associated work item in the source application. For example, draft, prototype, or design.
    • WorkItemCurrentStatusCode; string; The code that represents the current status of the associated work item in the source application.
    • WorkItemName; string; 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; The revision of the associated work item in the source application.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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 get all work items for all the tasks of a project 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

Response Body Example

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

{
items:[
	{
		 "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