Jump to

• Request
• Response
• Examples

Update an expense resource assignment for a project task

patch

/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/ExpenseResourceAssignments/{ExpenseResourceAssignmentId}

Request

Path Parameters

• ExpenseResourceAssignmentId(required): integer(int64)
  Unique identifier of the expense resource assignment to 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

• ExpenseResourceActualAmount: number
  Title: Actual Amount

  Default Value: 0

  Specifies the actual expense cost amount of a specific expense resource assigned to the task.
• ExpenseResourceAssignmentId: integer (int64)
  Title: Expense Resource Assignment ID

  Unique identifier of the expense resource assignment to the project task.
• ExpenseResourceId: integer (int64)
  Title: Expense Resource ID

  Identifier of the expense resource assigned to the project task.
• ExpenseResourceName: string
  Name of the expense resource assigned to the project task.
• ExpenseResourcePlannedAmount: number
  Title: Planned Expense Amount

  Default Value: 0

  Specifies the planned expense cost amount of a specific expense resource assigned to the task.
• ExpenseResourceRemainingAmount: number
  Title: Remaining Amount

  Default Value: 0

  The sum of remaining expense cost amounts of a specific expense resource assigned to the task.
• ProjElementId: integer (int64)
  Title: Task ID

  Identifier of the task to which the expense resource is assigned.

{
    "type":"object",
    "properties":{
        "ExpenseResourceRemainingAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The sum of remaining expense cost amounts of a specific expense resource assigned to the task.",
            "nullable":true,
            "default":"0"
        },
        "ProjElementId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Identifier of the task to which the expense resource is assigned.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ExpenseResourceAssignmentId":{
            "title":"Expense Resource Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the expense resource assignment to the project task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ExpenseResourceName":{
            "type":"string",
            "description":"Name of the expense resource assigned to the project task.",
            "nullable":true
        },
        "ExpenseResourceActualAmount":{
            "title":"Actual Amount",
            "type":"number",
            "description":"Specifies the actual expense cost amount of a specific expense resource assigned to the task.",
            "nullable":true,
            "default":"0"
        },
        "ExpenseResourceId":{
            "title":"Expense Resource ID",
            "type":"integer",
            "description":"Identifier of the expense resource assigned to the project task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ExpenseResourcePlannedAmount":{
            "title":"Planned Expense Amount",
            "type":"number",
            "description":"Specifies the planned expense cost amount of a specific expense resource assigned to the task.",
            "nullable":true,
            "default":"0"
        }
    }
}

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-ExpenseResourceAssignments-item-response

Type: object

Show Source

• ExpenseResourceActualAmount: number
  Title: Actual Amount

  Default Value: 0

  Specifies the actual expense cost amount of a specific expense resource assigned to the task.
• ExpenseResourceAssignmentId: integer (int64)
  Title: Expense Resource Assignment ID

  Unique identifier of the expense resource assignment to the project task.
• ExpenseResourceId: integer (int64)
  Title: Expense Resource ID

  Identifier of the expense resource assigned to the project task.
• ExpenseResourceName: string
  Name of the expense resource assigned to the project task.
• ExpenseResourcePlannedAmount: number
  Title: Planned Expense Amount

  Default Value: 0

  Specifies the planned expense cost amount of a specific expense resource assigned to the task.
• ExpenseResourceRemainingAmount: number
  Title: Remaining Amount

  Default Value: 0

  The sum of remaining expense cost amounts of a specific expense resource assigned to the task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjElementId: integer (int64)
  Title: Task ID

  Identifier of the task to which the expense resource is assigned.

{
    "type":"object",
    "properties":{
        "ExpenseResourceRemainingAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The sum of remaining expense cost amounts of a specific expense resource assigned to the task.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "ProjElementId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Identifier of the task to which the expense resource is assigned.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExpenseResourceAssignmentId":{
            "title":"Expense Resource Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the expense resource assignment to the project task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ExpenseResourceName":{
            "type":"string",
            "description":"Name of the expense resource assigned to the project task.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpenseResourceActualAmount":{
            "title":"Actual Amount",
            "type":"number",
            "description":"Specifies the actual expense cost amount of a specific expense resource assigned to the task.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "ExpenseResourceId":{
            "title":"Expense Resource ID",
            "type":"integer",
            "description":"Identifier of the expense resource assigned to the project task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpenseResourcePlannedAmount":{
            "title":"Planned Expense Amount",
            "type":"number",
            "description":"Specifies the planned expense cost amount of a specific expense resource assigned to the task.",
            "nullable":true,
            "default":"0",
            "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.0.0/projects/300100093207556/child/Tasks/300100093207564/child/ExpenseResourceAssignments/300100089715751

Example of Request Body

The following example shows the request body to update the planned and actual amounts for the expense resource assignment with expense resource assignment ID 300100089715751 for the project task with task ID 300100093207564 that belongs to the project with project ID 300100093207556.

{
  "ExpenseResourcePlannedAmount": 2000,
  "ExpenseResourceActualAmount": 800
}

Example of Response Body

The following example shows the contents of the response body in JSON format, including the updated expense resource planned and actual amounts.

{
  "ExpenseResourceActualAmount" : 800,
  "ExpenseResourceAssignmentId" : 300100089715751,
  "ExpenseResourceId" : 1001,
  "ExpenseResourceName" : "Air",
  "ExpenseResourcePlannedAmount" : 2000,
  "ExpenseResourceRemainingAmount" : 1200,
  "ProjElementId" : 300100093207564,
  "links" : [{
    "rel" : "self",      
    ...
            }]
  ...
}

Back to Top