Jump to

• Request
• Response
• Examples

Update a labor resource assignment for a task

patch

/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskLaborResourceAssignments/{TaskLaborResourceAssignmentId}

Request

Path Parameters

• ProjectId(required): integer(int64)
  Unique identifier of the project.
• TaskLaborResourceAssignmentId(required): integer(int64)
  Unique identifier of the labor resource assignment for the project task. Value is auto-generated when using POST and mandatory when using PATCH.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActualBillAmount: number
  Title: Actual Labor Resource Bill Amount

  The actual bill amount for the labor resource associated with the task.
• ActualCostAmount: number
  Title: Actual Labor Resource Cost Amount

  The actual cost amount for the labor resource associated with the task.
• ActualEffortinHours: number
  Title: Actual Labor Resource Effort in Hours

  Default Value: 0

  Actual effort in hours for the labor resource assigned to the task.
• CurrentBillAmount: number
  Title: Current Labor Resource Bill Amount

  The current bill amount for the labor resource associated with the task.
• CurrentCostAmount: number
  Title: Current Labor Resource Cost Amount

  The current cost amount for the labor resource associated with the task.
• CurrentEffortinHours: number
  Title: Current Labor Resource Effort in Hours

  Estimated effort in hours on the task at completion for the labor resource.
• EffectiveBillRate: number
  Title: Effective Bill Rate

  Indicates the rate derived from the rate schedule for calculating the bill amount.
• EffectiveCostRate: number
  Title: Effective Cost Rate

  Indicates the rate derived from the rate schedule for calculating the burdened cost.
• IntegrationSource: string
  Title: Integration Source

  Indicates the task was created in a third-party application.
• LaborResourceId: integer (int64)
  Title: Labor Resource ID

  Unique identifier of the labor resource assigned to the project task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both.
• PercentComplete: number
  Title: Labor Resource Percent Complete

  Default Value: 0

  Indicates the percentage of work completed for the labor resource assigned to the task.
• PlannedBillAmount: number
  Title: Planned Labor Resource Bill Amount

  The planned bill amount for the labor resource associated with the task.
• PlannedCostAmount: number
  Title: Planned Labor Resource Cost Amount

  The planned cost amount for the labor resource associated with the task.
• PlannedEffortinHours: number
  Title: Planned Labor Resource Effort in Hours

  Planned effort in hours of the labor resource assigned to the task.
• PrimaryResourceFlag: boolean
  Title: Primary Resource

  Indicates whether the resource is the primary labor resource for the project task. The resource is the primary labor resource when the value is True. The value is False when the resource is not the primary labor resource. Default value is False.
• ProgressStatus: string
  Title: Labor Resource Progress Status

  Maximum Length: 20

  Indicates the status of the work for the labor resource assigned to the task.
• ProjectResourceAssignId: integer
  Title: Project Resource Assignment ID

  Unique identifier of the assignment of the labor resource in a project.
• RemainingBillAmount: number
  Title: Remaining Labor Resource Bill Amount

  The remaining bill amount for the labor resource associated with the task.
• RemainingCostAmount: number
  Title: Remaining Labor Resource Cost Amount

  The remaining cost amount for the labor resource associated with the task.
• RemainingEffortinHours: number
  Title: Remaining Labor Resource Effort in Hours

  Remaining effort in hours for the labor resource assigned to the task.
• ResourceAllocation: number
  Title: Labor Resource Allocation

  Allocation percentage of the labor resource assigned to the task. Default value is the same as the resource allocation for the project.
• ResourceEmail: string
  Title: Labor Resource Email

  Maximum Length: 240

  Email address of the labor resource assigned to the task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both.

{
    "type":"object",
    "properties":{
        "CurrentCostAmount":{
            "title":"Current Labor Resource Cost Amount",
            "type":"number",
            "description":"The current cost amount for the labor resource associated with the task.",
            "nullable":true
        },
        "ActualBillAmount":{
            "title":"Actual Labor Resource Bill Amount",
            "type":"number",
            "description":"The actual bill amount for the labor resource associated with the task.",
            "nullable":true
        },
        "RemainingCostAmount":{
            "title":"Remaining Labor Resource Cost Amount",
            "type":"number",
            "description":"The remaining cost amount for the  labor resource associated with the task.",
            "nullable":true
        },
        "PlannedEffortinHours":{
            "title":"Planned Labor Resource Effort in Hours",
            "type":"number",
            "description":"Planned effort in hours of the labor resource assigned to the task.",
            "nullable":true
        },
        "PlannedBillAmount":{
            "title":"Planned Labor Resource Bill Amount",
            "type":"number",
            "description":"The planned bill amount for the labor resource associated with the task.",
            "nullable":true
        },
        "ProjectResourceAssignId":{
            "title":"Project Resource Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the assignment of the labor resource in a project.",
            "nullable":true
        },
        "LaborResourceId":{
            "title":"Labor Resource ID",
            "type":"integer",
            "description":"Unique identifier of the labor resource assigned to the project task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ProjectResourceAssignId",
                    "ResourceEmail"
                ]
            }
        },
        "EffectiveBillRate":{
            "title":"Effective Bill Rate",
            "type":"number",
            "description":"Indicates the rate derived from the rate schedule for calculating the bill amount.",
            "nullable":true
        },
        "PlannedCostAmount":{
            "title":"Planned Labor Resource Cost Amount",
            "type":"number",
            "description":"The planned cost amount for the labor resource associated with the task.",
            "nullable":true
        },
        "IntegrationSource":{
            "title":"Integration Source",
            "type":"string",
            "description":"Indicates the task was created in a third-party application.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrentEffortinHours":{
            "title":"Current Labor Resource Effort in Hours",
            "type":"number",
            "description":"Estimated effort in hours on the task at completion for the labor resource.",
            "nullable":true
        },
        "RemainingBillAmount":{
            "title":"Remaining Labor Resource Bill Amount",
            "type":"number",
            "description":"The remaining bill amount for the labor resource associated with the task.",
            "nullable":true
        },
        "ResourceAllocation":{
            "title":"Labor Resource Allocation",
            "type":"number",
            "description":"Allocation percentage of the labor resource assigned to the task. Default value is the same as the resource allocation for the project.",
            "nullable":true
        },
        "PrimaryResourceFlag":{
            "title":"Primary Resource",
            "type":"boolean",
            "description":"Indicates whether the resource is the primary labor resource for the project task. The resource is the primary labor resource when the value is True. The value is False when the resource is not the primary labor resource. Default value is False.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LaborResourceId",
                    "PrimaryResourceId",
                    "ResourceEmail"
                ]
            }
        },
        "ProgressStatus":{
            "title":"Labor Resource Progress Status",
            "maxLength":"20",
            "type":"string",
            "description":"Indicates the status of the work for the labor resource assigned to the task.",
            "nullable":true
        },
        "ActualEffortinHours":{
            "title":"Actual Labor Resource Effort in Hours",
            "type":"number",
            "description":"Actual effort in hours for the labor resource assigned to the task.",
            "nullable":true,
            "default":"0"
        },
        "PercentComplete":{
            "title":"Labor Resource Percent Complete",
            "type":"number",
            "description":"Indicates the percentage of work completed for the labor resource assigned to the task.",
            "nullable":true,
            "default":"0"
        },
        "CurrentBillAmount":{
            "title":"Current Labor Resource Bill Amount",
            "type":"number",
            "description":"The current bill amount for the labor resource associated with the task.",
            "nullable":true
        },
        "RemainingEffortinHours":{
            "title":"Remaining Labor Resource Effort in Hours",
            "type":"number",
            "description":"Remaining effort in hours for the labor resource assigned to the task.",
            "nullable":true
        },
        "EffectiveCostRate":{
            "title":"Effective Cost Rate",
            "type":"number",
            "description":"Indicates the rate derived from the rate schedule for calculating the burdened cost.",
            "nullable":true
        },
        "ActualCostAmount":{
            "title":"Actual Labor Resource Cost Amount",
            "type":"number",
            "description":"The actual cost amount for the labor resource associated with the task.",
            "nullable":true
        },
        "ResourceEmail":{
            "title":"Labor Resource Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email address of the labor resource assigned to the task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ProjectResourceAssignId"
                ]
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : projectPlans-TaskLaborResourceAssignments-item-response

Type: object

Show Source

• ActualBillAmount: number
  Title: Actual Labor Resource Bill Amount

  The actual bill amount for the labor resource associated with the task.
• ActualCostAmount: number
  Title: Actual Labor Resource Cost Amount

  The actual cost amount for the labor resource associated with the task.
• ActualEffortinHours: number
  Title: Actual Labor Resource Effort in Hours

  Default Value: 0

  Actual effort in hours for the labor resource assigned to the task.
• CurrentBillAmount: number
  Title: Current Labor Resource Bill Amount

  The current bill amount for the labor resource associated with the task.
• CurrentCostAmount: number
  Title: Current Labor Resource Cost Amount

  The current cost amount for the labor resource associated with the task.
• CurrentEffortinHours: number
  Title: Current Labor Resource Effort in Hours

  Estimated effort in hours on the task at completion for the labor resource.
• EffectiveBillRate: number
  Title: Effective Bill Rate

  Indicates the rate derived from the rate schedule for calculating the bill amount.
• EffectiveCostRate: number
  Title: Effective Cost Rate

  Indicates the rate derived from the rate schedule for calculating the burdened cost.
• IntegrationSource: string
  Title: Integration Source

  Indicates the task was created in a third-party application.
• LaborResourceId: integer (int64)
  Title: Labor Resource ID

  Unique identifier of the labor resource assigned to the project task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PercentComplete: number
  Title: Labor Resource Percent Complete

  Default Value: 0

  Indicates the percentage of work completed for the labor resource assigned to the task.
• PlannedBillAmount: number
  Title: Planned Labor Resource Bill Amount

  The planned bill amount for the labor resource associated with the task.
• PlannedCostAmount: number
  Title: Planned Labor Resource Cost Amount

  The planned cost amount for the labor resource associated with the task.
• PlannedEffortinHours: number
  Title: Planned Labor Resource Effort in Hours

  Planned effort in hours of the labor resource assigned to the task.
• PrimaryResourceFlag: boolean
  Title: Primary Resource

  Indicates whether the resource is the primary labor resource for the project task. The resource is the primary labor resource when the value is True. The value is False when the resource is not the primary labor resource. Default value is False.
• ProgressStatus: string
  Title: Labor Resource Progress Status

  Maximum Length: 20

  Indicates the status of the work for the labor resource assigned to the task.
• ProjectResourceAssignId: integer
  Title: Project Resource Assignment ID

  Unique identifier of the assignment of the labor resource in a project.
• RemainingBillAmount: number
  Title: Remaining Labor Resource Bill Amount

  The remaining bill amount for the labor resource associated with the task.
• RemainingCostAmount: number
  Title: Remaining Labor Resource Cost Amount

  The remaining cost amount for the labor resource associated with the task.
• RemainingEffortinHours: number
  Title: Remaining Labor Resource Effort in Hours

  Remaining effort in hours for the labor resource assigned to the task.
• ResourceAllocation: number
  Title: Labor Resource Allocation

  Allocation percentage of the labor resource assigned to the task. Default value is the same as the resource allocation for the project.
• ResourceEmail: string
  Title: Labor Resource Email

  Maximum Length: 240

  Email address of the labor resource assigned to the task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both.
• ResourceName: string
  Title: Labor Resource Name

  Read Only: true

  Maximum Length: 240

  Name of the labor resource assigned to the project task.
• TaskId: integer (int64)
  Title: Task ID

  Identifier of the task to which the labor resource is assigned. Value is mandatory when using POST.
• TaskLaborResourceAssignmentId: integer (int64)
  Title: Labor Resource Assignment ID

  Read Only: true

  Unique identifier of the labor resource assignment for the project task. Value is auto-generated when using POST and mandatory when using PATCH.

{
    "type":"object",
    "properties":{
        "CurrentCostAmount":{
            "title":"Current Labor Resource Cost Amount",
            "type":"number",
            "description":"The current cost amount for the labor resource associated with the task.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualBillAmount":{
            "title":"Actual Labor Resource Bill Amount",
            "type":"number",
            "description":"The actual bill amount for the labor resource associated with the task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Identifier of the task to which the labor resource is assigned. Value is mandatory when using POST.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlannedEffortinHours":{
            "title":"Planned Labor Resource Effort in Hours",
            "type":"number",
            "description":"Planned effort in hours of the labor resource assigned to the task.",
            "nullable":true,
            "x-queryable":true
        },
        "PlannedBillAmount":{
            "title":"Planned Labor Resource Bill Amount",
            "type":"number",
            "description":"The planned bill amount for the labor resource associated with the task.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Labor Resource Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the labor resource assigned to the project task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectResourceAssignId":{
            "title":"Project Resource Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the assignment of the labor resource in a project.",
            "nullable":true,
            "x-queryable":true
        },
        "PlannedCostAmount":{
            "title":"Planned Labor Resource Cost Amount",
            "type":"number",
            "description":"The planned cost amount for the labor resource associated with the task.",
            "nullable":true,
            "x-queryable":true
        },
        "IntegrationSource":{
            "title":"Integration Source",
            "type":"string",
            "description":"Indicates the task was created in a third-party application.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceAllocation":{
            "title":"Labor Resource Allocation",
            "type":"number",
            "description":"Allocation percentage of the labor resource assigned to the task. Default value is the same as the resource allocation for the project.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualEffortinHours":{
            "title":"Actual Labor Resource Effort in Hours",
            "type":"number",
            "description":"Actual effort in hours for the labor resource assigned to the task.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "TaskLaborResourceAssignmentId":{
            "title":"Labor Resource Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the labor resource assignment for the project task. Value is auto-generated when using POST and mandatory when using PATCH.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveCostRate":{
            "title":"Effective Cost Rate",
            "type":"number",
            "description":"Indicates the rate derived from the rate schedule for calculating the burdened cost.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualCostAmount":{
            "title":"Actual Labor Resource Cost Amount",
            "type":"number",
            "description":"The actual cost amount for the labor resource associated with the task.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceEmail":{
            "title":"Labor Resource Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email address of the labor resource assigned to the task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ProjectResourceAssignId"
                ]
            },
            "x-queryable":true
        },
        "RemainingCostAmount":{
            "title":"Remaining Labor Resource Cost Amount",
            "type":"number",
            "description":"The remaining cost amount for the  labor resource associated with the task.",
            "nullable":true,
            "x-queryable":true
        },
        "LaborResourceId":{
            "title":"Labor Resource ID",
            "type":"integer",
            "description":"Unique identifier of the labor resource assigned to the project task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ProjectResourceAssignId",
                    "ResourceEmail"
                ]
            },
            "x-queryable":true
        },
        "EffectiveBillRate":{
            "title":"Effective Bill Rate",
            "type":"number",
            "description":"Indicates the rate derived from the rate schedule for calculating the bill amount.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentEffortinHours":{
            "title":"Current Labor Resource Effort in Hours",
            "type":"number",
            "description":"Estimated effort in hours on the task at completion for the labor resource.",
            "nullable":true,
            "x-queryable":true
        },
        "RemainingBillAmount":{
            "title":"Remaining Labor Resource Bill Amount",
            "type":"number",
            "description":"The remaining bill amount for the labor resource associated with the task.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryResourceFlag":{
            "title":"Primary Resource",
            "type":"boolean",
            "description":"Indicates whether the resource is the primary labor resource for the project task. The resource is the primary labor resource when the value is True. The value is False when the resource is not the primary labor resource. Default value is False.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LaborResourceId",
                    "PrimaryResourceId",
                    "ResourceEmail"
                ]
            },
            "x-queryable":true
        },
        "ProgressStatus":{
            "title":"Labor Resource Progress Status",
            "maxLength":"20",
            "type":"string",
            "description":"Indicates the status of the work for the labor resource assigned to the task.",
            "nullable":true,
            "x-queryable":true
        },
        "PercentComplete":{
            "title":"Labor Resource Percent Complete",
            "type":"number",
            "description":"Indicates the percentage of work completed for the labor resource assigned to the task.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "CurrentBillAmount":{
            "title":"Current Labor Resource Bill Amount",
            "type":"number",
            "description":"The current bill amount for the labor resource associated with the task.",
            "nullable":true,
            "x-queryable":true
        },
        "RemainingEffortinHours":{
            "title":"Remaining Labor Resource Effort in Hours",
            "type":"number",
            "description":"Remaining effort in hours for the labor resource assigned to the task.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to update an expense 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/projectPlans/300100124723999/child/TaskLaborResourceAssignments/300100124762026

Request Body Example

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

{

"ResourceEmail" : "[e-mail]"
}

Response Body Example

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

{
  "ActualBillAmount" : null,
  "ActualCostAmount" : null,
  "CurrentBillAmount" : null,
  "CurrentCostAmount" : null,
  "LaborResourceId" : 300100023180799,
  "PlannedBillAmount" : null,
  "PlannedCostAmount" : null,
  "PlannedEffortinHours" : null,
  "PrimaryResourceFlag" : false,
  "RemainingBillAmount" : null,
  "RemainingCostAmount" : null,
  "ResourceAllocation" : 100.000000000000000,
  "ResourceName" : "George White",
  "ResourceEmail" : "[e-mail]",
  "TaskId" : 300100124764034,
  "TaskLaborResourceAssignmentId" : 300100124762026
}

Back to Top