1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Project Resource Assignments

Get all project resource assignments

get

/fscmRestApi/resources/11.13.18.05/projectResourceAssignments

Request

Query Parameters
  • 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 an assignment with the specified primary key.
      Finder Variables:
      • AssignmentId; integer; Unique identifier of the project resource assignment.
  • 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:
    • AdjustmentType; string; Type of adjustment if some adjustment has happenned on the project resource assignment.
    • AdjustmentTypeCode; string; Code for the adjustment performed on the project resource assignment.
    • AssignmentComments; string; Additional details for the project resource assignment.
    • AssignmentEndDate; string; The date until which the resource is engaged on the project assignment. If no value is passed when creating the assignment, it defaults to project end date.
    • AssignmentExternalIdentifier; string; Identifier of the assignment in an external application.
    • AssignmentHoursPerDay; number; A period of time measured in hours for each day for the project resource assignment. Mandatory if you are passing Use Project Calendar Flag attribute value as N.
    • AssignmentHoursPerWeek; number; Hours for every week of the assignment duration. Applicable only if Use Weekly Hours Indicator value is true.
    • AssignmentId; integer; Unique identifier of the project resource assignment.
    • AssignmentLocation; string; Location for the work specified on the project resource assignment.
    • AssignmentName; string; The name given to a project resource assignment. This name is used to identify an assignment.
    • AssignmentStartDate; string; The date from which the resource is assigned to the project assignment. If no value is passed when creating the assignment, it defaults to the system date for all already started projects and to project start date for all projects starting in future. If the assignment start date is provided and is before the project's start date, the assignment will still be created.
    • AssignmentStatusCode; string; Status code of the assignment.
    • AssignmentStatusName; string; Status of the assignment.
    • AssignmentType; string; Indicates if the assignment is a billable or a nonbillable assignment.
    • AssignmentTypeCode; string; Code to indicate if the assignment is a billable assignment or a nonbillable assignment.
    • BillRate; number; Rate that represents the targeted bill rate for the resource on the assignment.
    • BillRateCurrencyCode; string; Code of the currency used to define the bill rate. The bill rate currency must be the same as the project currency.
    • BillablePercent; integer; Indicates the percentage of assignment time that is billable for an assignment that is defined as Billable assignment. For a nonbillable assignment, the value is ignored. Valid values are positive integer between 0 and 100.
    • BillablePercentReason; string; Indicates the reason why the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.
    • BillablePercentReasonCode; string; Code that indicates the reason why the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.
    • CanceledBy; string; The user who canceled the project resource assignment, if the assignment is canceled.
    • CanceledByResourceId; integer; Unique Identifier of the resource who canceled the project resource assignment, if the assignment is canceled.
    • CancellationDate; string; Date of cancellation if the assignment is canceled.
    • CancellationReason; string; Reason of cancellation if the assignment is canceled.
    • CostRate; number; Rate that represents the cost rate for the resource on the assignment.
    • CostRateCurrencyCode; string; Code of the currency used to define the cost rate.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • FridayHours; number; Hours for Friday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdatedBy; string; The user who last updated the record.
    • MondayHours; number; Hours for Monday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator value is true.
    • ProjResourceId; integer; Identifier of the project labor resource associated with the project resource assignment.
    • ProjectId; integer; Unique identifier of the project associated to the resource assignment. To identify the project, you may provide a value only for this attribute, the Project Number attribute, or the Project Name attribute. Project is mandatory when creating an assignment.
    • ProjectManagementFlowFlag; boolean; Flag that indicates if the action is called in the project manager flow. Set this value only if the service is being called in the project manager flow. Default value will be set to resource management flow which is the primary applicationation of the service.
    • ProjectName; string; Name of the project associated to the resource assignment. To identify the project associated to the assignment, you may provide a value only for this attribute, Project ID attribute, or the Project Number attribute.
    • ProjectNumber; string; Unique number of the project associated to the resource assignment. To identify the project associated to the assignment, you may provide a value only for this attribute or the Project ID attribute or the Project Name attribute.
    • ProjectRoleId; integer; Identifier of the role that the selected resource is assigned to on a project assignment. To identify the project role, you may provide a value for this attribute or for Project Role Name attribute but not both. Project Role value is mandatory when creating an assignment.
    • ProjectRoleName; string; Name of the role that the selected resource is assigned to on a project resource assignment. To identify the project role, you may provide a value for only this attribute or for Project Role ID attribute but not both.
    • ReservationExpirationDate; string; Date until which the resource should be reserved on the project. On or before this date, you should either confirm the assignment or cancel the reservation.
    • ReservationReason; string; Reason for reserving a resource on the project resource assignment. You may provide a value for this attribute or for Resource Reason Code attribute but not both. Applies only if the Assignment Status is RESERVED.
    • ReservationReasonCode; string; Code for the reason for reserving a resource on the project resource assignment. You may provide a value for this attribute or for Reservation Reason attribute but not both. Applies only if the Assignment Status is RESERVED.
    • ResourceEmail; string; Email of the resource who is selected for the assignment. To identify the resource, you may provide a value for this attribute or for Resource ID attribute but not both.
    • ResourceHCMPersonId; integer; HCM person identifier for the project enterprise resource who is selected for the assignment.
    • ResourceId; integer; Unique identifier of the resource who is selected for the assignment. To identify the resource, you may provide a value for this attribute or for Resource Email attribute but not both. Resource is mandatory when creating an assignment.
    • ResourceName; string; Name of the resource that is selected for the assignment.
    • SaturdayHours; number; Hours for Saturday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
    • SundayHours; number; Hours for Sunday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
    • ThursdayHours; number; Hours for Thursday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
    • TotalAssignedHours; number; The total number of hours for a project resource assignment calculated based on the date range, daily hours, working days, and calendar exceptions.
    • TuesdayHours; number; Hours for Tuesday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
    • UseDailyHoursFlag; boolean; Indicates if the hours for the assignment vary each day. Valid values are True and False. If the value is True, the assignment hours can vary each day of the project resource assignment.
    • UseProjectCalendarFlag; boolean; Indicates if the hours for the assignment are provided in Assignment Hours Per Day attribute or if it should be derived from the project calendar. Valid values are Y and N. If the value is Y, the assignment hours are derived from the project calendar.
    • UseVariableHoursFlag; boolean; Indicates if the hours for the assignment are variable for every day of the week or not. Valid values are True and False. If the value is True, the assignment hours are derived from the attributes Monday Hours through Sunday Hours.
    • UseWeeklyHoursFlag; boolean; Indicates if the hours for the assignment are for every week or not. Valid values are True and False. If the value is True, the assignment hours are derived from the attribute AssignmentHoursPerWeek.
    • WednesdayHours; number; Hours for Wednesday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
  • 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 : projectResourceAssignments
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : projectResourceAssignments-item-response
Type: object
Show Source
  • Title: Adjustment Type
    Read Only: true
    Maximum Length: 80
    Type of adjustment if some adjustment has happenned on the project resource assignment.
  • Title: Adjustment Type Code
    Read Only: true
    Maximum Length: 30
    Code for the adjustment performed on the project resource assignment.
  • Title: Assignment Additional Comments
    Maximum Length: 2000
    Additional details for the project resource assignment.
  • Title: Assignment End Date
    The date until which the resource is engaged on the project assignment. If no value is passed when creating the assignment, it defaults to project end date.
  • Title: Assignment External Identifier
    Maximum Length: 100
    Identifier of the assignment in an external application.
  • Title: Assignment Hours per Day
    A period of time measured in hours for each day for the project resource assignment. Mandatory if you are passing Use Project Calendar Flag attribute value as N.
  • Title: Assignment Hours per Week
    Hours for every week of the assignment duration. Applicable only if Use Weekly Hours Indicator value is true.
  • Title: Assignment ID
    Read Only: true
    Unique identifier of the project resource assignment.
  • Title: Assignment Location
    Maximum Length: 240
    Location for the work specified on the project resource assignment.
  • Title: Assignment Name
    Maximum Length: 240
    The name given to a project resource assignment. This name is used to identify an assignment.
  • Title: Assignment Start Date
    The date from which the resource is assigned to the project assignment. If no value is passed when creating the assignment, it defaults to the system date for all already started projects and to project start date for all projects starting in future. If the assignment start date is provided and is before the project's start date, the assignment will still be created.
  • Title: Assignment Status Code
    Maximum Length: 30
    Status code of the assignment.
  • Title: Assignment Status
    Maximum Length: 80
    Status of the assignment.
  • Title: Assignment Type
    Maximum Length: 80
    Indicates if the assignment is a billable or a nonbillable assignment.
  • Title: Assignment Type Code
    Maximum Length: 30
    Code to indicate if the assignment is a billable assignment or a nonbillable assignment.
  • Title: Billable Percent
    Indicates the percentage of assignment time that is billable for an assignment that is defined as Billable assignment. For a nonbillable assignment, the value is ignored. Valid values are positive integer between 0 and 100.
  • Title: Billable Percent Reason
    Maximum Length: 80
    Indicates the reason why the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.
  • Title: Billable Percent Reason Code
    Maximum Length: 30
    Code that indicates the reason why the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.
  • Title: Bill Rate
    Rate that represents the targeted bill rate for the resource on the assignment.
  • Title: Bill Rate Currency Code
    Maximum Length: 15
    Code of the currency used to define the bill rate. The bill rate currency must be the same as the project currency.
  • Title: Canceled By
    Read Only: true
    Maximum Length: 240
    The user who canceled the project resource assignment, if the assignment is canceled.
  • Title: Canceled by Resource ID
    Read Only: true
    Unique Identifier of the resource who canceled the project resource assignment, if the assignment is canceled.
  • Title: Cancellation Date
    Read Only: true
    Date of cancellation if the assignment is canceled.
  • Title: Cancellation Reason
    Read Only: true
    Maximum Length: 2000
    Reason of cancellation if the assignment is canceled.
  • Title: Cost Rate
    Rate that represents the cost rate for the resource on the assignment.
  • Title: Cost Rate Currency Code
    Maximum Length: 15
    Code of the currency used to define the cost rate.
  • 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: Friday Hours
    Hours for Friday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
  • 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: Monday Hours
    Hours for Monday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator value is true.
  • Title: Project ID
    Unique identifier of the project associated to the resource assignment. To identify the project, you may provide a value only for this attribute, the Project Number attribute, or the Project Name attribute. Project is mandatory when creating an assignment.
  • Title: Project Management Flow Indicator
    Flag that indicates if the action is called in the project manager flow. Set this value only if the service is being called in the project manager flow. Default value will be set to resource management flow which is the primary applicationation of the service.
  • Title: Project Name
    Maximum Length: 240
    Name of the project associated to the resource assignment. To identify the project associated to the assignment, you may provide a value only for this attribute, Project ID attribute, or the Project Number attribute.
  • Title: Project Number
    Maximum Length: 25
    Unique number of the project associated to the resource assignment. To identify the project associated to the assignment, you may provide a value only for this attribute or the Project ID attribute or the Project Name attribute.
  • Title: Project Role ID
    Identifier of the role that the selected resource is assigned to on a project assignment. To identify the project role, you may provide a value for this attribute or for Project Role Name attribute but not both. Project Role value is mandatory when creating an assignment.
  • Title: Project Role Name
    Maximum Length: 240
    Name of the role that the selected resource is assigned to on a project resource assignment. To identify the project role, you may provide a value for only this attribute or for Project Role ID attribute but not both.
  • Title: Project Resource ID
    Read Only: true
    Identifier of the project labor resource associated with the project resource assignment.
  • Title: Reservation Expiration Date
    Date until which the resource should be reserved on the project. On or before this date, you should either confirm the assignment or cancel the reservation.
  • Title: Reservation Reason
    Maximum Length: 80
    Reason for reserving a resource on the project resource assignment. You may provide a value for this attribute or for Resource Reason Code attribute but not both. Applies only if the Assignment Status is RESERVED.
  • Title: Reservation Reason
    Maximum Length: 30
    Code for the reason for reserving a resource on the project resource assignment. You may provide a value for this attribute or for Reservation Reason attribute but not both. Applies only if the Assignment Status is RESERVED.
  • Title: Resource Email
    Maximum Length: 240
    Email of the resource who is selected for the assignment. To identify the resource, you may provide a value for this attribute or for Resource ID attribute but not both.
  • Title: Resource Person ID
    Read Only: true
    HCM person identifier for the project enterprise resource who is selected for the assignment.
  • Title: Resource ID
    Unique identifier of the resource who is selected for the assignment. To identify the resource, you may provide a value for this attribute or for Resource Email attribute but not both. Resource is mandatory when creating an assignment.
  • Title: Resource Name
    Read Only: true
    Maximum Length: 240
    Name of the resource that is selected for the assignment.
  • Title: Saturday Hours
    Hours for Saturday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
  • Title: Sunday Hours
    Hours for Sunday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
  • Title: Thursday Hours
    Hours for Thursday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
  • Title: Total Assigned Hours
    Read Only: true
    The total number of hours for a project resource assignment calculated based on the date range, daily hours, working days, and calendar exceptions.
  • Title: Tuesday Hours
    Hours for Tuesday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
  • Title: Use Daily Hours Indicator
    Read Only: true
    Indicates if the hours for the assignment vary each day. Valid values are True and False. If the value is True, the assignment hours can vary each day of the project resource assignment.
  • Title: Use Project Calendar Indicator
    Maximum Length: 1
    Default Value: true
    Indicates if the hours for the assignment are provided in Assignment Hours Per Day attribute or if it should be derived from the project calendar. Valid values are Y and N. If the value is Y, the assignment hours are derived from the project calendar.
  • Title: Use Variable Hours Indicator
    Indicates if the hours for the assignment are variable for every day of the week or not. Valid values are True and False. If the value is True, the assignment hours are derived from the attributes Monday Hours through Sunday Hours.
  • Title: Use Weekly Hours Indicator
    Indicates if the hours for the assignment are for every week or not. Valid values are True and False. If the value is True, the assignment hours are derived from the attribute AssignmentHoursPerWeek.
  • Title: Wednesday Hours
    Hours for Wednesday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
Links
validateForGanttCreation
The method validates the single assignment schedule creation. It returns a list of errors and warnings if the new assignment doesn't pass the validation.
validateForGanttMultiAdjustment
The method validates multiple assignment schedule changes. It returns a list of errors and warnings if the adjusted schedule doesn't pass the validation.
Back to Top

Examples

The following example shows how to get all project resource assignments 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/projectResourceAssignments

Response Body Example

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

{
  "items": [
    {
      "AssignmentId": 300100025520061,
      "ResourceId": 300100025504859,
      "ResourceEmail": "Veronica.Johnson@Oracle.com",
      "ResourceHCMPersonId": 300100007741638,
      "ResourceName": "Veronica Johnson",
      "ProjectId": 300100025404084,
      "ProjectNumber": "300100025404084",
      "ProjectName": "zBIQA_Rel8_RM9",
      "AssignmentStartDate": "2014-01-01",
      "AssignmentEndDate": "2014-07-01",
      "AssignmentStatusCode": "PENDING_ADJUSTMENT",
      "AssignmentStatusName": "Pending Adjustment",
      "ProjectRoleId": 300100024326360,
      "ProjectRoleName": "zBIQA_Rel8_Role1 (2)",
      "UseProjectCalendarFlag": true,
      "AssignmentHoursPerDay": null,
      "CostRateCurrencyCode": "USD",
      "CostRate": null,
      "BillRateCurrencyCode": "USD",
      "BillRate": null,
      "AssignmentLocation": "New York",
      "ReservationReasonCode": null,
      "ReservationReason": null,
      "ReservationExpirationDate": null,
      "AssignmentComments": "Project #2 for zBIQA_Rel8_RM9 (Role - zBIQA_Rel8_Role1)",
      "AssignmentExternalIdentifier": null,
      "AdjustmentType": "Cancel Assignment",
      "AdjustmentTypeCode": "CANCEL",
      "CanceledBy": "Abraham Mason",
      "CanceledByResourceId": 300100024326751,
      "CancellationDate": null,
      "CancellationReason": "Pending Adjustment Type",
      "CreationDate": "2013-08-19T14:50:56.006+00:00",
      "CreatedBy": "Abraham.Mason",
      "LastUpdateDate": "2013-08-19T14:52:09.456+00:00",
      "LastUpdatedBy": "Abraham.Mason",
      "AssignmentTypeCode": null,
      "BillablePercent": null,
      "BillablePercentReasonCode": null,
      "AssignmentType": null,
      "BillablePercentReason": null,
      "ProjectManagementFlowFlag": null,
      "UseVariableHoursFlag": "false",
      "SundayHours": null,
      "MondayHours": null,
      "TuesdayHours": null,
      "WednesdayHours": null,
      "ThursdayHours": null,
      "FridayHours": null,
      "SaturdayHours": null,
      "links": [
        {
          "rel": "self",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/300100025520061",
          "name": "projectResourceAssignments",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
          }
        },
        {
          "rel": "canonical",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/300100025520061",
          "name": "projectResourceAssignments",
          "kind": "item"
        },
        {
          "rel": "action",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/300100025520061/action/cancelAssignment",
          "name": "cancelAssignment",
          "kind": "other"
        },
        {
          "rel": "action",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/300100025520061/action/adjustAssignmentSchedule",
          "name": "adjustAssignmentSchedule",
          "kind": "other"
        }
      ]
    },
...
}
Back to Top