Update a project resource assignment
patch
/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}
Request
Path Parameters
-
AssignmentId(required): integer
Unique identifier of the project resource assignment.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AssignmentComments: string
Title:
Assignment Additional Comments
Maximum Length:2000
Additional details for the project resource assignment. -
AssignmentExternalIdentifier: string
Title:
Assignment External Identifier
Maximum Length:100
Identifier of the assignment in an external application. -
AssignmentLocation: string
Title:
Assignment Location
Maximum Length:240
Location for the work specified on the project resource assignment. -
AssignmentName: string
Title:
Assignment Name
Maximum Length:240
The name given to a project resource assignment. This name is used to identify an assignment. -
AssignmentType: string
Title:
Assignment Type
Maximum Length:80
Indicates if the assignment is a billable or a nonbillable assignment. -
AssignmentTypeCode: string
Title:
Assignment Type Code
Maximum Length:30
Code to indicate if the assignment is a billable assignment or a nonbillable assignment. -
BillablePercent: integer
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. -
BillablePercentReason: string
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. -
BillablePercentReasonCode: string
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. -
BillRate: number
Title:
Bill Rate
Rate that represents the targeted bill rate for the resource on the assignment. -
BillRateCurrencyCode: string
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. -
CostRate: number
Title:
Cost Rate
Rate that represents the cost rate for the resource on the assignment. -
CostRateCurrencyCode: string
Title:
Cost Rate Currency Code
Maximum Length:15
Code of the currency used to define the cost rate. -
ReservationExpirationDate: string
(date)
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. -
ReservationReason: string
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. -
ReservationReasonCode: string
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : projectResourceAssignments-item-response
Type:
Show Source
object
-
AdjustmentType: string
Title:
Adjustment Type
Read Only:true
Maximum Length:80
Type of adjustment if some adjustment has happenned on the project resource assignment. -
AdjustmentTypeCode: string
Title:
Adjustment Type Code
Read Only:true
Maximum Length:30
Code for the adjustment performed on the project resource assignment. -
AssignmentComments: string
Title:
Assignment Additional Comments
Maximum Length:2000
Additional details for the project resource assignment. -
AssignmentEndDate: string
(date)
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. -
AssignmentExternalIdentifier: string
Title:
Assignment External Identifier
Maximum Length:100
Identifier of the assignment in an external application. -
AssignmentHoursPerDay: number
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. -
AssignmentHoursPerWeek: number
Title:
Assignment Hours per Week
Hours for every week of the assignment duration. Applicable only if Use Weekly Hours Indicator value is true. -
AssignmentId: integer
Title:
Assignment ID
Read Only:true
Unique identifier of the project resource assignment. -
AssignmentLocation: string
Title:
Assignment Location
Maximum Length:240
Location for the work specified on the project resource assignment. -
AssignmentName: string
Title:
Assignment Name
Maximum Length:240
The name given to a project resource assignment. This name is used to identify an assignment. -
AssignmentStartDate: string
(date)
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. -
AssignmentStatusCode: string
Title:
Assignment Status Code
Maximum Length:30
Status code of the assignment. -
AssignmentStatusName: string
Title:
Assignment Status
Maximum Length:80
Status of the assignment. -
AssignmentType: string
Title:
Assignment Type
Maximum Length:80
Indicates if the assignment is a billable or a nonbillable assignment. -
AssignmentTypeCode: string
Title:
Assignment Type Code
Maximum Length:30
Code to indicate if the assignment is a billable assignment or a nonbillable assignment. -
BillablePercent: integer
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. -
BillablePercentReason: string
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. -
BillablePercentReasonCode: string
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. -
BillRate: number
Title:
Bill Rate
Rate that represents the targeted bill rate for the resource on the assignment. -
BillRateCurrencyCode: string
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. -
CanceledBy: string
Title:
Canceled By
Read Only:true
Maximum Length:240
The user who canceled the project resource assignment, if the assignment is canceled. -
CanceledByResourceId: integer
(int64)
Title:
Canceled by Resource ID
Read Only:true
Unique Identifier of the resource who canceled the project resource assignment, if the assignment is canceled. -
CancellationDate: string
(date)
Title:
Cancellation Date
Read Only:true
Date of cancellation if the assignment is canceled. -
CancellationReason: string
Title:
Cancellation Reason
Read Only:true
Maximum Length:2000
Reason of cancellation if the assignment is canceled. -
CostRate: number
Title:
Cost Rate
Rate that represents the cost rate for the resource on the assignment. -
CostRateCurrencyCode: string
Title:
Cost Rate Currency Code
Maximum Length:15
Code of the currency used to define the cost rate. -
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. -
FridayHours: number
Title:
Friday Hours
Hours for Friday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true. -
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. -
MondayHours: number
Title:
Monday Hours
Hours for Monday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator value is true. -
ProjectId: integer
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. -
ProjectManagementFlowFlag: boolean
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. -
ProjectName: string
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. -
ProjectNumber: string
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. -
ProjectRoleId: integer
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. -
ProjectRoleName: string
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. -
ProjResourceId: integer
(int64)
Title:
Project Resource ID
Read Only:true
Identifier of the project labor resource associated with the project resource assignment. -
ReservationExpirationDate: string
(date)
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. -
ReservationReason: string
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. -
ReservationReasonCode: string
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. -
ResourceEmail: string
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. -
ResourceHCMPersonId: integer
(int64)
Title:
Resource Person ID
Read Only:true
HCM person identifier for the project enterprise resource who is selected for the assignment. -
ResourceId: integer
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. -
ResourceName: string
Title:
Resource Name
Read Only:true
Maximum Length:240
Name of the resource that is selected for the assignment. -
SaturdayHours: number
Title:
Saturday Hours
Hours for Saturday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true. -
SundayHours: number
Title:
Sunday Hours
Hours for Sunday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true. -
ThursdayHours: number
Title:
Thursday Hours
Hours for Thursday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true. -
TotalAssignedHours: number
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. -
TuesdayHours: number
Title:
Tuesday Hours
Hours for Tuesday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true. -
UseDailyHoursFlag: boolean
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. -
UseProjectCalendarFlag: boolean
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. -
UseVariableHoursFlag: boolean
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. -
UseWeeklyHoursFlag: boolean
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. -
WednesdayHours: number
Title:
Wednesday Hours
Hours for Wednesday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
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.
Links
- adjustAssignmentSchedule
-
Parameters:
- AssignmentId:
$request.path.AssignmentId
Perform project resource assignment schedule change via this action. The schedule change can happen due to assignment date changes and/or changes in assignment hours per day. The assignment must be in Confirmed or Reserved status to perform this action. - AssignmentId:
- cancelAssignment
-
Operation: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/cancelAssignmentParameters:
- AssignmentId:
$request.path.AssignmentId
Cancel a project resource assignment. - AssignmentId:
- cancelAssignmentAdjustment
-
Parameters:
- AssignmentId:
$request.path.AssignmentId
Cancel project resource adjustment request with this action. The request must be in pending adjustment status to allow this action. - AssignmentId:
- confirmReservedAssignment
-
Parameters:
- AssignmentId:
$request.path.AssignmentId
Confirm a reserved project resource assignment. - AssignmentId:
- replaceResource
-
Operation: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/replaceResourceParameters:
- AssignmentId:
$request.path.AssignmentId
Replace existing resource with a different resource on a project resource assignment with this action. The resource assignment must be in confirmed or reserved status to allow this action. - AssignmentId:
- validateForGanttAdjustment
-
Parameters:
- AssignmentId:
$request.path.AssignmentId
The method validates single assignment schedule change. It returns back a list of errors and warnings if the adjusted schedule doesn't pass the validation. - AssignmentId:
Examples
The following example shows how to a project resource assignment by submitting a PATCH request on the REST resource using cURL.
curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/300100110955121
Request Body Example
The following shows an example of the request body in JSON format.
{ "CostRate": 151, "BillRate": 161, "AssignmentLocation": "Fremont", "ReservationReason": "In Training", "ReservationExpirationDate": "2015-01-03", "AssignmentComments": "Its a reserved assignment-2", "AssignmentExternalIdentifier": "AsgId1235" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "AssignmentId": 300100110955121, "ResourceId": 300100023180829, "ResourceEmail": "Camille.Artois@Oracle.com", "ResourceHCMPersonId": 300100007721182, "ResourceName": "Camille Artois", "ProjectId": 100000012047562, "ProjectNumber": "VTest Cable", "ProjectName": "VTest Cable", "AssignmentStartDate": "2017-07-20", "AssignmentEndDate": "2017-07-25", "AssignmentStatusCode": "ASSIGNED", "AssignmentStatusName": "Confirmed", "ProjectRoleId": 300100025498083, "ProjectRoleName": "Oracle DBA", "UseProjectCalendarFlag": true, "AssignmentHoursPerDay": null, "CostRateCurrencyCode": "USD", "CostRate": 151, "BillRateCurrencyCode": "USD", "BillRate": 161, "AssignmentLocation": "Fremont", "ReservationReasonCode": null, "ReservationReason": null, "ReservationExpirationDate": null, "AssignmentComments": "Its a reserved assignment-2", "AssignmentExternalIdentifier": "AsgId1235", "AdjustmentType": null, "AdjustmentTypeCode": null, "CanceledBy": null, "CanceledByResourceId": null, "CancellationDate": null, "CancellationReason": null, "CreationDate": "2017-07-20T22:04:48+00:00", "CreatedBy": "Connor.Horton", "LastUpdateDate": "2019-03-20T06:32:22+00:00", "LastUpdatedBy": "Connor.Horton", "AssignmentTypeCode": null, "BillablePercent": null, "BillablePercentReasonCode": null, "AssignmentType": null, "BillablePercentReason": null, "ProjectManagementFlowFlag": null }