Jump to

• Request
• Response
• Examples

Update a labor resource assignment for a task

patch

/fscmRestApi/resources/11.13.18.05/workPlanTemplates/{WorkPlanTemplateId}/child/TaskLaborResourceAssignments/{TaskLaborResourceAssignmentId}

Request

Path Parameters

• TaskLaborResourceAssignmentId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• WorkPlanTemplateId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• CostAmount: number
  Title: Planned Labor Resource Cost Amount

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

  Planned effort in hours of the labor resource for the task.
• LaborBillAmount: number
  Title: Planned Labor Resource Bill Amount

  The planned bill amount of the labor resource for the task.
• LaborResourceId: integer (int64)
  Title: Labor Resource ID

  Unique identifier of the labor resource assigned to the task.
• PrimaryResourceFlag: boolean
  Title: Primary Resource

  Indicates whether the resource is the primary labor resource for the task. The value is True if the resource is the primary labor resource. The value is False if the resource isn't the primary labor resource.
• ResourceAllocation: number
  Title: Labor Resource Allocation

  Allocation percentage of the labor resource for the task.
• ResourceEmail: string
  Title: Labor Resource Email

  Email address of the labor resource assigned to the task.
• ResourceName: string
  Title: Labor Resource Name

  Name of the labor resource assigned to the task.
• TemplateResourceAssignmentId: integer
  Title: Template Resource Assignment ID

  Unique identifier of the assignment of the labor resource.

{
    "type":"object",
    "properties":{
        "PrimaryResourceFlag":{
            "title":"Primary Resource",
            "type":"boolean",
            "description":"Indicates whether the resource is the primary labor resource for the task. The value is True if the resource is the primary labor resource. The value is False if the resource isn't the primary labor resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LaborResourceId",
                    "ResourceEmail",
                    "ResourceName"
                ]
            }
        },
        "ResourceName":{
            "title":"Labor Resource Name",
            "type":"string",
            "description":"Name of the labor resource assigned to the task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LaborResourceId",
                    "ResourceEmail"
                ]
            }
        },
        "EffortInHours":{
            "title":"Planned Labor Resource Effort in Hours",
            "type":"number",
            "description":"Planned effort in hours of the labor resource for the task.",
            "nullable":true,
            "x-queryable":false
        },
        "TemplateResourceAssignmentId":{
            "title":"Template Resource Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the assignment of the labor resource.",
            "nullable":true
        },
        "CostAmount":{
            "title":"Planned Labor Resource Cost Amount",
            "type":"number",
            "description":"The planned cost amount of the labor resource for the task.",
            "nullable":true,
            "x-queryable":false
        },
        "LaborResourceId":{
            "title":"Labor Resource ID",
            "type":"integer",
            "description":"Unique identifier of the labor resource assigned to the task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "TemplateResourceAssignmentId"
                ]
            }
        },
        "LaborBillAmount":{
            "title":"Planned Labor Resource Bill Amount",
            "type":"number",
            "description":"The planned bill amount of the labor resource for the task.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceAllocation":{
            "title":"Labor Resource Allocation",
            "type":"number",
            "description":"Allocation percentage of the labor resource for the task.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceEmail":{
            "title":"Labor Resource Email",
            "type":"string",
            "description":"Email address of the labor resource assigned to the task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LaborResourceId"
                ]
            }
        }
    }
}

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 : workPlanTemplates-TaskLaborResourceAssignments-item-response

Type: object

Show Source

• CostAmount: number
  Title: Planned Labor Resource Cost Amount

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

  Planned effort in hours of the labor resource for the task.
• LaborBillAmount: number
  Title: Planned Labor Resource Bill Amount

  The planned bill amount of the labor resource for the task.
• LaborResourceId: integer (int64)
  Title: Labor Resource ID

  Unique identifier of the labor resource assigned to the task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryResourceFlag: boolean
  Title: Primary Resource

  Indicates whether the resource is the primary labor resource for the task. The value is True if the resource is the primary labor resource. The value is False if the resource isn't the primary labor resource.
• ResourceAllocation: number
  Title: Labor Resource Allocation

  Allocation percentage of the labor resource for the task.
• ResourceEmail: string
  Title: Labor Resource Email

  Email address of the labor resource assigned to the task.
• ResourceName: string
  Title: Labor Resource Name

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

  Unique identifier of the task to which the labor resource is assigned.
• TaskLaborResourceAssignmentId: integer (int64)
  Title: Labor Resource Assignment ID

  Read Only: true

  Unique identifier of the labor resource assignment for the task. Value is auto-generated.
• TemplateResourceAssignmentId: integer
  Title: Template Resource Assignment ID

  Unique identifier of the assignment of the labor resource.

{
    "type":"object",
    "properties":{
        "PrimaryResourceFlag":{
            "title":"Primary Resource",
            "type":"boolean",
            "description":"Indicates whether the resource is the primary labor resource for the task. The value is True if the resource is the primary labor resource. The value is False if the resource isn't the primary labor resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LaborResourceId",
                    "ResourceEmail",
                    "ResourceName"
                ]
            }
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Unique identifier of the task to which the labor resource is assigned.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskLaborResourceAssignmentId":{
            "title":"Labor Resource Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the labor resource assignment for the task. Value is auto-generated.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Labor Resource Name",
            "type":"string",
            "description":"Name of the labor resource assigned to the task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LaborResourceId",
                    "ResourceEmail"
                ]
            }
        },
        "EffortInHours":{
            "title":"Planned Labor Resource Effort in Hours",
            "type":"number",
            "description":"Planned effort in hours of the labor resource for the task.",
            "nullable":true,
            "x-queryable":false
        },
        "TemplateResourceAssignmentId":{
            "title":"Template Resource Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the assignment of the labor resource.",
            "nullable":true,
            "x-queryable":true
        },
        "CostAmount":{
            "title":"Planned Labor Resource Cost Amount",
            "type":"number",
            "description":"The planned cost amount of the labor resource for the task.",
            "nullable":true,
            "x-queryable":false
        },
        "LaborResourceId":{
            "title":"Labor Resource ID",
            "type":"integer",
            "description":"Unique identifier of the labor resource assigned to the task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "TemplateResourceAssignmentId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LaborBillAmount":{
            "title":"Planned Labor Resource Bill Amount",
            "type":"number",
            "description":"The planned bill amount of the labor resource for the task.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceAllocation":{
            "title":"Labor Resource Allocation",
            "type":"number",
            "description":"Allocation percentage of the labor resource for the task.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceEmail":{
            "title":"Labor Resource Email",
            "type":"string",
            "description":"Email address of the labor resource assigned to the task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LaborResourceId"
                ]
            }
        }
    }
}

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 a labor resource assignment for a task 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/workPlanTemplates/100100148369454/child/TaskLaborResourceAssignments/100100148369467

Request Body Example

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

{
"TaskId": 100100148369456,
"LaborResourceId": 300100024326656,
"ResourceName": "George White",
"ResourceEmail" : "[e-mail]"
}

Response Body Example

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

{
"TaskLaborResourceAssignmentId": 100100148369467,
"TaskId": 100100148369456,
"LaborResourceId": 300100024326656,
"ResourceName": "George White",
"ResourceEmail": "[e-mail]",
"PrimaryResourceFlag": true,
"ResourceAllocation": 100,
"LaborBillAmount": 0,
"CostAmount": 0,
"EffortInHours": 0,
"TemplateResourceAssignmentId": 100100148369485,
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/TaskLaborResourceAssignments/100100148369467",
"name": "TaskLaborResourceAssignments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/TaskLaborResourceAssignments/100100148369467",
"name": "TaskLaborResourceAssignments",
"kind": "item"
},
{
"rel": "parent",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454",
"name": "workPlanTemplates",
"kind": "item"
}
]
}

Back to Top