Jump to

• Request
• Response
• Examples

Update a labor resource assignment for a project task

patch

/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/LaborResourceAssignments/{LaborResourceAssignmentId}

Request

Path Parameters

• LaborResourceAssignmentId(required): integer(int64)
  Unique identifier of the labor resource assignment for the project task.
• ProjectId(required): integer(int64)
  Unique identifier of the project.
• TasksUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Tasks resource and used to uniquely identify an instance of Tasks. The client should not generate the hash key value. Instead, the client should query on the Tasks collection resource in order to navigate to a specific instance of Tasks to get the hash key.

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

• LaborBilledAmount: number
  Title: Planned Labor Bill Amount

  Specifies the labor bill amount of the task.
• LaborCostAmount: number
  Title: Labor Cost

  Specifies the labor cost of the task.
• LaborPrimaryResource: string
  Title: Primary Labor Resource ID

  Indicates that the resource is the primary labor resource for the project task.
• LaborResourceEmail: string
  Title: Resource Email

  E-mail address of the labor resource assigned to the task. Required if the resource type is Labor.
• LaborResourceId: integer (int64)
  Title: Labor Resource ID

  Unique identifier of the labor resource assigned to the project task.
• LaborResourceName: string
  Title: Labor Resource Name

  Name of the labor resource assigned to the project task.
• ProjectResourceAssignId: integer
  Title: Project Resource Assignment ID

  Unique identifier of the assignment of the labor resource in a project.
• ProjElementId: integer (int64)
  Title: Task ID

  Identifier of the task to which the labor resource is assigned.
• ResourceAllocationPercent: number
  Title: Labor Resource Allocation

  Allocation percentage of the labor resource assigned to the task.

{
    "type":"object",
    "properties":{
        "LaborBilledAmount":{
            "title":"Planned Labor Bill Amount",
            "type":"number",
            "description":"Specifies the labor bill amount of the task.",
            "nullable":true
        },
        "LaborPrimaryResource":{
            "title":"Primary Labor Resource ID",
            "type":"string",
            "description":"Indicates that the resource is the primary labor resource for the project task.",
            "nullable":true
        },
        "ResourceAllocationPercent":{
            "title":"Labor Resource Allocation",
            "type":"number",
            "description":"Allocation percentage of the labor resource assigned to the task.",
            "nullable":true
        },
        "ProjElementId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Identifier of the task to which the labor resource is assigned.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LaborCostAmount":{
            "title":"Labor Cost",
            "type":"number",
            "description":"Specifies the labor cost of the task.",
            "nullable":true
        },
        "LaborResourceEmail":{
            "title":"Resource Email",
            "type":"string",
            "description":"E-mail address of the labor resource assigned to the task. Required if the resource type is Labor.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ProjectResourceAssignId"
                ]
            }
        },
        "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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ProjectResourceAssignId"
                ]
            }
        },
        "LaborResourceName":{
            "title":"Labor Resource Name",
            "type":"string",
            "description":"Name of the labor resource assigned to the project task.",
            "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 : projects-Tasks-LaborResourceAssignments-item-response

Type: object

Show Source

• LaborBilledAmount: number
  Title: Planned Labor Bill Amount

  Specifies the labor bill amount of the task.
• LaborCostAmount: number
  Title: Labor Cost

  Specifies the labor cost of the task.
• LaborPrimaryResource: string
  Title: Primary Labor Resource ID

  Indicates that the resource is the primary labor resource for the project task.
• LaborResourceAssignmentId: integer (int64)
  Title: Labor Resource Assignment ID

  Read Only: true

  Unique identifier of the labor resource assignment for the project task.
• LaborResourceEmail: string
  Title: Resource Email

  E-mail address of the labor resource assigned to the task. Required if the resource type is Labor.
• LaborResourceId: integer (int64)
  Title: Labor Resource ID

  Unique identifier of the labor resource assigned to the project task.
• LaborResourceName: string
  Title: Labor Resource Name

  Name of the labor resource assigned to the project task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectResourceAssignId: integer
  Title: Project Resource Assignment ID

  Unique identifier of the assignment of the labor resource in a project.
• ProjElementId: integer (int64)
  Title: Task ID

  Identifier of the task to which the labor resource is assigned.
• ResourceAllocationPercent: number
  Title: Labor Resource Allocation

  Allocation percentage of the labor resource assigned to the task.

{
    "type":"object",
    "properties":{
        "LaborBilledAmount":{
            "title":"Planned Labor Bill Amount",
            "type":"number",
            "description":"Specifies the labor bill amount of the task.",
            "nullable":true,
            "x-queryable":true
        },
        "LaborPrimaryResource":{
            "title":"Primary Labor Resource ID",
            "type":"string",
            "description":"Indicates that the resource is the primary labor resource for the project task.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceAllocationPercent":{
            "title":"Labor Resource Allocation",
            "type":"number",
            "description":"Allocation percentage of the labor resource assigned to the task.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjElementId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Identifier of the task to which the labor resource is assigned.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LaborCostAmount":{
            "title":"Labor Cost",
            "type":"number",
            "description":"Specifies the labor cost of the task.",
            "nullable":true,
            "x-queryable":true
        },
        "LaborResourceEmail":{
            "title":"Resource Email",
            "type":"string",
            "description":"E-mail address of the labor resource assigned to the task. Required if the resource type is Labor.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ProjectResourceAssignId"
                ]
            },
            "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
        },
        "LaborResourceId":{
            "title":"Labor Resource ID",
            "type":"integer",
            "description":"Unique identifier of the labor resource assigned to the project task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ProjectResourceAssignId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LaborResourceName":{
            "title":"Labor Resource Name",
            "type":"string",
            "description":"Name of the labor resource assigned to the project task.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ProjectResourceAssignId"
                ]
            },
            "x-queryable":true
        },
        "LaborResourceAssignmentId":{
            "title":"Labor Resource Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the labor resource assignment for the project task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "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 a labor 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.0.0/projects/300100093207556/child/Tasks/300100093207564/child/LaborResourceAssignments/300100093207565

Example of Request Body

The following example shows the request body to update the labor cost amount, labor billed amount, and primary resource indicator for the labor resource assignment with labor resource assignment ID 300100093207565 for the task with task ID 300100093207564 that belongs to the project with project ID 300100093207556.

{
  "LaborBilledAmount": 500,
  "LaborCostAmount": 400,
  "LaborPrimaryResource": "Y"
}

Example of Response Body

The following example shows the contents of the response body in JSON format, including the updated labor cost and labor billed amounts.

{
  "LaborBilledAmount" : 500,
  "LaborCostAmount" : 400,
  "LaborPrimaryResource" : null,
  "LaborResourceAssignmentId" : 300100093207565,
  "LaborResourceEmail" : "[e-mail]",
  "LaborResourceId" : 300100024326655,
  "LaborResourceName" : "Connor Horton",
  "ProjElementId" : 300100093207564,
  "ResourceAllocationPercent" : 100,
  "links" : [{
    ...
            }]
}

Back to Top