Jump to

• Request
• Response
• Examples

Update an expense resource assignment for a task

patch

/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/TaskExpenseResourceAssignments/{TaskExpenseResourceAssignmentId}

Request

Path Parameters

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

• ActualAmount: number
  Title: Expense Resource Actual Amount

  Default Value: 0

  The actual expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.
• CurrentAmount: number
  Title: Expense Resource Current Amount

  The current expense cost amount of a specific expense resource assigned to the task. It is auto-calculated as the sum of Expense Resource Actual Amount plus Expense Resource Remaining Amount.
• ExpenseResourceId: integer (int64)
  Title: Expense Resource ID

  Identifier of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both.
• IntegrationSource: string
  Title: Integration Source

  Indicates the task was created in a third-party application.
• PlannedAmount: number
  Title: Expense Resource Planned Amount

  Default Value: 0

  The planned expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.
• RemainingAmount: number
  Title: Expense Resource Remaining Amount

  Default Value: 0

  The remaining expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.
• ResourceName: string
  Title: Expense Resource Name

  Maximum Length: 240

  Name of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both.

{
    "type":"object",
    "properties":{
        "ResourceName":{
            "title":"Expense Resource Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both.",
            "nullable":true
        },
        "ExpenseResourceId":{
            "title":"Expense Resource ID",
            "type":"integer",
            "description":"Identifier of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ResourceName"
                ]
            }
        },
        "ActualAmount":{
            "title":"Expense Resource Actual Amount",
            "type":"number",
            "description":"The actual expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.",
            "nullable":true,
            "default":0
        },
        "PlannedAmount":{
            "title":"Expense Resource Planned Amount",
            "type":"number",
            "description":"The planned expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.",
            "nullable":true,
            "default":0
        },
        "CurrentAmount":{
            "title":"Expense Resource Current Amount",
            "type":"number",
            "description":"The current expense cost amount of a specific expense resource assigned to the task. It is auto-calculated as the sum of Expense Resource Actual Amount plus Expense Resource Remaining Amount.",
            "nullable":true
        },
        "IntegrationSource":{
            "title":"Integration Source",
            "type":"string",
            "description":"Indicates the task was created in a third-party application.",
            "nullable":true,
            "x-queryable":false
        },
        "RemainingAmount":{
            "title":"Expense Resource Remaining Amount",
            "type":"number",
            "description":"The remaining expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.",
            "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 : projectPlans-TaskExpenseResourceAssignments-item-response

Type: object

Show Source

• ActualAmount: number
  Title: Expense Resource Actual Amount

  Default Value: 0

  The actual expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.
• CurrentAmount: number
  Title: Expense Resource Current Amount

  The current expense cost amount of a specific expense resource assigned to the task. It is auto-calculated as the sum of Expense Resource Actual Amount plus Expense Resource Remaining Amount.
• ExpenseResourceId: integer (int64)
  Title: Expense Resource ID

  Identifier of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both.
• IntegrationSource: string
  Title: Integration Source

  Indicates the task was created in a third-party application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlannedAmount: number
  Title: Expense Resource Planned Amount

  Default Value: 0

  The planned expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.
• RemainingAmount: number
  Title: Expense Resource Remaining Amount

  Default Value: 0

  The remaining expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.
• ResourceName: string
  Title: Expense Resource Name

  Maximum Length: 240

  Name of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both.
• TaskExpenseResourceAssignmentId: integer (int64)
  Title: Expense Resource Assignment ID

  Read Only: true

  Unique identifier of the expense resource assignment to the project task. Value is auto-generated when using POST and mandatory when using PATCH.
• TaskId: integer (int64)
  Title: Task ID

  Identifier of the task to which the expense resource is assigned. Value is mandatory when using POST and must refer to a task that already exists in the project.

{
    "type":"object",
    "properties":{
        "TaskExpenseResourceAssignmentId":{
            "title":"Expense Resource Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the expense resource assignment to 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
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Identifier of the task to which the expense resource is assigned. Value is mandatory when using POST and must refer to a task that already exists in the project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Expense Resource Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpenseResourceId":{
            "title":"Expense Resource ID",
            "type":"integer",
            "description":"Identifier of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ResourceName"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActualAmount":{
            "title":"Expense Resource Actual Amount",
            "type":"number",
            "description":"The actual expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "PlannedAmount":{
            "title":"Expense Resource Planned Amount",
            "type":"number",
            "description":"The planned expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "CurrentAmount":{
            "title":"Expense Resource Current Amount",
            "type":"number",
            "description":"The current expense cost amount of a specific expense resource assigned to the task. It is auto-calculated as the sum of Expense Resource Actual Amount plus Expense Resource Remaining Amount.",
            "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
        },
        "RemainingAmount":{
            "title":"Expense Resource Remaining Amount",
            "type":"number",
            "description":"The remaining expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST.",
            "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.18.05/projectPlans/300100124723999/child/TaskExpenseResourceAssignments/300100124762029

Request Body Example

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

{
"ResourceName" : "Air",
"ActualAmount" : 100,
 "PlannedAmount" : 51
}

Response Body Example

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

{
    "ActualAmount": 100,
    "CurrentAmount": 100,
    "TaskExpenseResourceAssignmentId": 300100124762029,
    "ExpenseResourceId": 1001,
    "PlannedAmount": 51,
    "RemainingAmount": 0,
    "ResourceName": "Air",
    "TaskId": 300100124764034}

Back to Top