Get a project resource request

get

/fscmRestApi/resources/11.13.18.05/projectResourceRequests/{ResourceRequestId}

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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : projectResourceRequests-item-response
Type: object
Show Source
  • Title: Assigned Quantity
    Read Only: true
    The number of resources assigned to the project for the resource request.
  • Title: Assignment Type
    Maximum Length: 80
    Indicates if the request is for a billable or a nonbillable assignment.
  • Title: Assignment Type Code
    Maximum Length: 30
    Code to indicate if the request is for a billable or a nonbillable assignment. Examples are BILLABLE, NONBILLABLE, or leave blank.
  • Title: Billable Percent
    The percentage of assignment time that will be billable, if the request is for a billable assignment. Valid values are positive integer between 0 and 100. For a nonbillable assignment, the value is ignored.
  • Title: Billable Percent Reason
    Maximum Length: 80
    Reason the billable percent is less than 100, if the request is for a billable assignment and the billable percent is less than 100. If the request is for nonbillable assignment, the value will be ignored.
  • Title: Billable Percent Reason Code
    Maximum Length: 30
    Code to indicate the reason the billable percent is less than 100, if the request is for a billable assignment and the billable percent is less than 100. If the request is for nonbillable assignment, the value will be ignored.
  • Title: Friday Hours
    Hours for Friday of every week for the requested time period. Applicable only if Use Variable Hours Indicator is true.
  • Links
  • Title: Location
    Maximum Length: 240
    Resource assignment location specificed on the resource request.
  • Title: Monday Hours
    Hours for Monday of every week for the requested time period. Applicable only if Use Variable Hours Indicator value is true.
  • Title: Project ID
    Unique identifier of the project associated to the resource request. 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 OPEN request.
  • Title: Project Name
    Maximum Length: 240
    Name of the project associated to the resource request. To identify the project, you may provide a value only for this attribute, the Project ID attribute, or the Project Name attribute.
  • Title: Project Number
    Maximum Length: 25
    Unique number of the project associated to the resource request. To identify the project, you may provide a value only for this attribute, the Project ID attribute, or the Project Name attribute.
  • Project Resource Request Descriptive Flexfields
    Title: Project Resource Request Descriptive Flexfields
    The Project Resource Request Descriptive Flexfields resource is used to view, create, and update descriptive flexfields associated to a project resource request.
  • Project Resource Request Lines
    Title: Project Resource Request Lines
    The Project Resource Request Lines resource is used to view the status and details of all proposed or nominated resources associated to the request.
  • Project Resource Request Qualifications
    Title: Project Resource Request Qualifications
    The Project Resource Request Qualifications resource is used to view, create, and manage project resource qualifications under a specific request.
  • Title: Project Role ID
    Unique identifier of the role that the selected resources will be assigned to on the project. You may enter a value only for this attribute or for Project Role Name but not both.
  • Title: Project Role
    Maximum Length: 240
    Role that the selected resources will be assigned to on the project. You may enter a value only for this attribute or for Project Role ID but not both.
  • Title: Proposed Quantity
    Read Only: true
    The number of resources proposed or nominated for the project resource request.
  • Title: Remaining Quantity
    Read Only: true
    Default Value: 1
    The number of resources remaining to fulfill the project resource request.
  • Title: Requested Finish Date
    Date until which a resource is requested. If no value is provided, the value is set to the project end date. You must provide a value if the project does not have an end date.
  • Title: Requested Hours per Day
    Default Value: 0
    Period of time measured in hours that establishes the number of requested hours per working day on a project resource request. You must provide a value if you have set the Use Project Calendar Indicator attribute value to N.
  • Title: Requested Hours per Week
    Hours for every week of the requested duration. Applicable only if Use Weekly Hours Indicator value is true.
  • Title: Requested Quantity
    Default Value: 1
    The quantity of resources requested for the project resource request. If no value is provided, the value is set to 1.
  • Title: Requested Resource Email
    Maximum Length: 240
    Email of the resource who is selected to fulfill the project resource request, if the Requested Quantity is equal to 1. You may enter a value for only this attribute or for Requested Resource ID but not both.
  • Title: Requested Resource ID
    Identifier of the resource who is selected to fulfill the project resource request, if the Requested Quantity is equal to 1. You may enter a value for only this attribute or for Requested Resource Email but not both.
  • Title: Requested Resource Name
    Read Only: true
    Maximum Length: 240
    Name of the project enterprise resource who is selected to fulfill the project resource request, if the Requested Quantity is equal to 1.
  • Title: Requested Resource Person ID
    Read Only: true
    HCM person identifier for the project enterprise resource who is selected to fulfill the project resource request, if the Requested Quantity is equal to 1.
  • Title: Requested Start Date
    Date from which a resource is requested. If no value is provided, the value is set to the current date for projects with start date in the past, and to the project start date for projects with start date in the future.
  • Title: Requester Email
    Maximum Length: 240
    Email of the project enterprise resource who requests the resources, mostly the project manager. You may enter a value only for this attribute or for Requester Resource ID but not both.
  • Title: Requester Name
    Read Only: true
    Maximum Length: 240
    Name of the project enterprise resource who requests the resources.
  • Title: Requester Person ID
    Read Only: true
    Identifier of the HCM person who requests the resources.
  • Title: Requester Resource ID
    Unique identifier of the project enterprise resource who requests the resources, mostly the project manager. You may enter a value only for this attribute or for Requester Email but not both.
  • Title: Request Fulfilled Date
    Read Only: true
    Date on which the project resource request is fulfilled.
  • Title: Request Name
    Maximum Length: 240
    Name of the project resource request.
  • Maximum Length: 30
    Default Value: RM
    The requester's role specificed on the resource request.
  • Title: Request Status
    Read Only: true
    Maximum Length: 80
    Status of the project resource request.
  • Title: Request Status Code
    Maximum Length: 30
    Default Value: DRAFT
    Code of the resource request status. The valid values are OPEN or DRAFT when creating the request. The default value is DRAFT. You can only update the request status from DRAFT to OPEN.
  • Title: Request Submitted Date
    Read Only: true
    Date on which the project resource request is submitted.
  • Title: Request ID
    Identifier of the project resource request.
  • Title: Saturday Hours
    Hours for Saturday of every week for the requested time period. Applicable only if Use Variable Hours Indicator is true.
  • Title: Special Instructions
    Maximum Length: 2000
    Special instructions for the project resource request, such as requester instructions to the resource manager.
  • Title: Staffing Owner Email
    Maximum Length: 240
    Email of the person who is responsible for finding resources to fulfill the request. You may enter a value for only this attribute or Staffing Owner ID but not both.
  • Title: Staffing Owner Name
    Read Only: true
    Maximum Length: 240
    Name of the person who is responsible for finding a resource to fulfill the request.
  • Title: Staffing Owner Person ID
    Read Only: true
    Identifier of the HCM person who is responsible for finding a resource to fulfill the request.
  • Title: Staffing Owner Resource ID
    Identifier of the project enterprise resource who is responsible for finding resources to fulfill the request. You may enter a value for only this attribute or for Staffing Owner Email but not both.
  • Title: Staffing Remarks
    Maximum Length: 2000
    Remarks added by the resource manager during staffing.
  • Title: Sunday Hours
    Hours for Sunday of every week for the requested time period. Applicable only if Use Variable Hours Indicator is true.
  • Title: Target Bill Rate
    Bill rate that represents the targeted rate for the resources who fulfill the request.
  • Title: Target Cost Rate Currency Code
    Maximum Length: 15
    Code of the currency used to define the bill rate.
  • Title: Target Cost Rate
    Cost rate that represents the targeted rate for the resources who are selected on the request.
  • Title: Target Cost Rate Currency Code
    Maximum Length: 15
    Code of the currency used to define the cost rate.
  • Title: Thursday Hours
    Hours for Thursday of every week for the requested time period. Applicable only if Use Variable Hours Indicator is true.
  • Title: Total Requested Hours
    Read Only: true
    Total requested hours for the resource for the particular assignment.
  • Title: Tuesday Hours
    Hours for Tuesday of every week for the requested time period. Applicable only if Use Variable Hours Indicator is true.
  • Title: Use Project Calendar Indicator
    Maximum Length: 1
    Default Value: true
    Flag that indicates if the hours for the assignment is provided in Requested Hours per Day attribute or should be derived from the project calendar. The valid values are Y and N. If the value is Y, the request hours is derived from the project calendar.
  • Title: Use Variable Hours Indicator
    Indicates if the hours for the request are variable for every day of the week or not. Valid values are True and False. If the value is True, the requested hours are derived from the attributes Monday Hours through Sunday Hours.
  • Title: Use Weekly Hours Indicator
    Indicates if the hours for the request are for every week or not. Valid values are True and False. If the value is True, the requested hours are derived from the attributes RequestedHoursPerWeek.
  • Title: Wednesday Hours
    Hours for Wednesday of every week for the requested time period. Applicable only if Use Variable Hours Indicator is true.
Nested Schema : Project Resource Request Descriptive Flexfields
Type: array
Title: Project Resource Request Descriptive Flexfields
The Project Resource Request Descriptive Flexfields resource is used to view, create, and update descriptive flexfields associated to a project resource request.
Show Source
Nested Schema : Project Resource Request Lines
Type: array
Title: Project Resource Request Lines
The Project Resource Request Lines resource is used to view the status and details of all proposed or nominated resources associated to the request.
Show Source
Nested Schema : Project Resource Request Qualifications
Type: array
Title: Project Resource Request Qualifications
The Project Resource Request Qualifications resource is used to view, create, and manage project resource qualifications under a specific request.
Show Source
Nested Schema : projectResourceRequests-ProjectResourceRequestDFF-item-response
Type: object
Show Source
Nested Schema : projectResourceRequests-ProjectResourceRequestLines-item-response
Type: object
Show Source
Nested Schema : projectResourceRequests-ProjectResourceRequestQualifications-item-response
Type: object
Show Source
  • Title: Competency Proficiency Level
    Level of expertise or ability to perform a competency. You may enter a value for only this attribute or for Competency Proficiency Level ID but not both.
  • Title: Competency Proficiency Level ID
    Identifier of the level of expertise or ability to perform a competency. You may enter a value for only this attribute or for Competency Proficiency Level but not both. Competency Proficiency level applies only if the Qualification Type value is Competency.
  • Title: Keyword
    Maximum Length: 240
    Unstructured words or phrases that appear as keywords on a project resource request.
  • Links
  • Title: Mandatory Qualification
    Maximum Length: 1
    Indicates whether the qualification is mandatory or optional.
  • Title: Qualification ID
    Identifier of a structured content item such as a competency or language. The structured content items are defined in HCM Talent Profile. You may enter a value for only this attribute or for Qualification Name but not both.
  • Title: Qualification Name
    Name of a structured content item such as a competency or language. The structured content items are defined in HCM Talent Profile. You may enter a value for only this attribute or for Qualification ID but not both.
  • Title: Qualification Type
    Type of the structured content item to indicate whether the qualification is Competency or Language.
  • Title: Reading Language Proficiency Level
    Level of ability to read text in a specific language. You may enter a value for only this attribute or for Reading Language Proficiency Level ID but not both.
  • Title: Reading Language Proficiency Level ID
    Identifier of the level of ability to read text in a specific language. You may enter a value for only this attribute or for Reading Language Proficiency Level Name but not both. Reading Language Proficiency level applies only if the Qualification Type value is Language.
  • Title: Resource Request Detail ID
    Read Only: true
    Unique identifier of the resource request qualification associated to the request.
  • Title: Content Section ID
    Identifier of the qualification content section. You may enter a value for only this attribute or for Content Section Name but not both.
  • Title: Content Section Name
    Maximum Length: 255
    Content section name for the qualification.
  • Title: Speaking Language Proficiency Level
    Level of ability to speak a specific language. You may enter a value for only this attribute or for Speaking Language Proficiency Level ID but not both.
  • Title: Speaking Language Proficiency Level ID
    Identifier of the level of ability to speak a specific language. You may enter a value for only this attribute or for Speaking Language Proficiency Level Name but not both. Speaking Language Proficiency level applies only if the Qualification Type value is Language.
  • Title: Writing Language Proficiency Level
    Level of ability to write text in a specific language. You may enter a value for only this attribute or for Writing Language Proficiency Level ID but not both.
  • Title: Writing Language Proficiency Level ID
    Identifier of the level of ability to write text in a specific language. You may enter a value for only this attribute or for Write Language Proficiency Level Name but not both. Writing Language Proficiency level applies only if the Qualification Type value is Language.
Back to Top

Examples

The following example shows how to get a project resource request 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/projectResourceRequests/300100185388392

Response Body Example

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

{
            "ResourceRequestId": 300100185388392,
            "RequestName": "Advanced Scheduling PayLoads Test",
            "RequestStatusCode": "OPEN",
            "RequestStatus": "Open",
            "RequestedStartDate": "2019-11-01",
            "RequestedFinishDate": "2019-11-02",
            "RequestFulfilledDate": null,
            "RequestedHoursperDay": null,
            "UseProjectCalendarFlag": false,
            "Location": null,
            "RequestedResourceId": 300100024326749,
            "RequestedResourceName": "Ravi Patel",
            "RequestedResourceEmail": "prj_ravi_patel_grp@oracle.com",
            "RequestedResourcePersonId": 11459,
            "ProjectId": 300100025404077,
            "ProjectName": "zBIQA_Rel8_RM8",
            "ProjectNumber": "300100025404077",
            "ProjectRoleId": 300100025498091,
            "ProjectRoleName": "QA Tester",
            "RequesterResourceId": 300100081800169,
            "RequesterName": "Martin Sims",
            "RequesterEmail": "martin.sims_dummy@oracle.com",
            "RequesterPersonId": 100010032551052,
            "SpecialInstructions": null,
            "StaffingOwnerResourceId": 300100026245821,
            "StaffingOwnerName": "Asha Preetam",
            "StaffingOwnerEmail": "Asha.Preetam@Oracle.com",
            "StaffingOwnerPersonId": 300100007668401,
            "StaffingRemarks": null,
            "RequestSubmittedDate": "2019-12-07",
            "TargetBillRate": null,
            "TargetBillRateCurrencyCode": null,
            "TargetCostRate": null,
            "TargetCostRateCurrencyCode": null,
            "RequestedQuantity": 1,
            "AssignedQuantity": 0,
            "ProposedQuantity": 0,
            "RemainingQuantity": 1,
            "AssignmentTypeCode": null,
            "AssignmentType": null,
            "BillablePercentReasonCode": null,
            "BillablePercentReason": null,
            "BillablePercent": null,
            "SundayHours": 0,
            "MondayHours": 2,
            "TuesdayHours": 3,
            "WednesdayHours": 4,
            "ThursdayHours": 5,
            "FridayHours": 6,
            "SaturdayHours": 0,
            "UseVariableHoursFlag": true
        
        }
Back to Top