Get all the projects for which the projects user can charge expenditures

get

/fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ChargeableProjects

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 all the chargeable projects across all assignments of the projects user.
      Finder Variables:
      • ProjectId; integer; The unique identifier of the project.
    • findByAssignmentIdAndDateRange: Finds all the project for which specified person ID are report expenditures in the specified date range.
      Finder Variables:
      • bindAssignmentId; integer; The unique identifier of the organization assignment of the projects user.
      • bindFinishDate; string; Finish date of the date range.
      • bindSearchText; string; Search the project based on project name, project number, project manager name, and project owning organization name.
      • bindStartDate; string; Start date of the date range.
    • findByPrimaryAssignmentAndDateRange: Finds all the projects for which the specified projects user can report expenditures in the specified date range.
      Finder Variables:
      • bindFinishDate; string; Finish date of the date range.
      • bindSearchText; string; Search the project based on project name, project number, project manager name, and project owning organization name.
      • bindStartDate; string; Start date of the date range.
    • findByTeamMemberAndDateRange: Finds all the project for which specified team member can report expenditures in the specified date range.
      Finder Variables:
      • bindAssignmentId; integer; The unique identifier of the organization assignment of the projects user.
      • bindFinishDate; string; Finish date of the date range.
      • bindStartDate; string; Start date of the date range.
  • 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:
    • AssignmentId; integer; The unique identifier of the organization assignment of the projects user.
    • AssignmentNumber; string; The unique reference of the organization assignment of the projects user.
    • BusinessUnitId; integer; The unique identifier of the business unit to which the project belongs.
    • BusinessUnitName; string; The name of the business unit to which the project belongs.
    • DefaultExpenditureTypeId; integer; The unique identifier of the default expenditure type set for a resource class in a project unit.
    • DefaultExpenditureTypeName; string; The name of the default expenditure type for a resource class in a project unit.
    • OwningOrganizationId; integer; The unique identifier of the organization that owns the project.
    • OwningOrganizationName; string; An organizing unit in the internal or external structure of the enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting for the project.
    • PrimaryAssignment; string; Indicates whether an assignment is the primary assignment of the projects user.
    • ProjectDescription; string; The description of the project.
    • ProjectFinishDate; string; The date that work or information tracking ends on a project.
    • ProjectId; integer; The unique identifier of the project.
    • ProjectManagerEmail; string; The email of the person who leads the project team and who has the authority and responsibility for meeting the project objectives.
    • ProjectManagerName; string; Name of the person who leads the project team and who has the authority and responsibility for meeting project objectives.
    • ProjectManagerResourceId; integer; The unique identifier of the person who leads the project team and who has the authority and responsibility for meeting the project objectives.
    • ProjectName; string; The name of the project that is being created.
    • ProjectNumber; string; The project number of the project.
    • ProjectStartDate; string; The date that work or information tracking begins on a project.
    • ProjectUnitId; integer; The unique identifier of the project unit assigned to the project.
    • ProjectUnitName; string; Name of the project unit assigned to the project.
  • 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 : projectsUsers-ChargeableProjects
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : projectsUsers-ChargeableProjects-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all the projects for which the projects user can charge expenditures 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/projectsUsers/300100024326751/child/ChargeableProjects

Response Body Example

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

{
    "items": [
        {
            "ProjectName": "T1",
            "ProjectNumber": "T1",
            "ProjectId": 300100051159179,
            "ProjectFinishDate": "2018-03-17",
            "OwningOrganizationId": 300100005722463,
            "ProjectDescription": "Template used in Proserv flow 1\n",
            "ProjectManagerResourceId": 100100038942319,
            "ProjectManagerName": "Abraham Mason",
            "ProjectManagerEmail": "prj_wf_in_grp@oracle.com",
            "OwningOrganizationName": "Operations-West",
            "BusinessUnitName": "Vision Operations",
            "BusinessUnitId": 204,
            "ProjectUnitName": "Project Operations",
            "DefaultExpenditureTypeName": "Miscellaneous Labor",
            "DefaultExpenditureTypeId": 100000010058006,
            "ProjectStartDate": "2013-01-01",
            "ProjectUnitId": 100010023900163,
            "AssignmentId": 100010032550835,
            "AssignmentNumber": "10032550833",
            "PrimaryAssignment": "Y",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectsUsers/300100024326751/child/ChargeableProjects/300100051159179",
                    "name": "ChargeableProjects",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectsUsers/300100024326751/child/ChargeableProjects/300100051159179",
                    "name": "ChargeableProjects",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectsUsers/300100024326751",
                    "name": "projectsUsers",
                    "kind": "item"
                }
            ]
        },
...
}
Back to Top