Jump to

• Request
• Response
• Examples

Update a project expense resource

patch

/fscmRestApi/resources/11.13.18.05/projectExpenseResources/{ProjResourceId}

Request

Path Parameters

• ProjResourceId(required): integer(int64)
  Unique identifier of the project resource.

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

• ExpenseAmount: number
  Title: Expense Amount

  Amount allocated in the project for the expense resource.
• Name: string
  Title: Name

  Maximum Length: 240

  Display name of the resource.
• ProjectName: string
  Title: Project Name

  Maximum Length: 240

  Name of the project.
• ProjectNumber: string
  Title: Project Number

  Maximum Length: 25

  Alphanumeric identifier of the project.
• ResourceId: integer (int64)
  Title: Resource ID

  Unique identifier of the project enterprise resource.

{
    "type":"object",
    "properties":{
        "ExpenseAmount":{
            "title":"Expense Amount",
            "type":"number",
            "description":"Amount allocated in the project for the expense resource.",
            "nullable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Unique identifier of the project enterprise resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project.",
            "nullable":false
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"Alphanumeric identifier of the project.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "ProjectId1"
                ]
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Display name of the resource.",
            "nullable":false
        }
    }
}

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 : projectExpenseResources-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Indicates the resource who created the row of data.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the row of data was created.
• ExpenseAmount: number
  Title: Expense Amount

  Amount allocated in the project for the expense resource.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the record was last edited.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Indicates who last edited the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 240

  Display name of the resource.
• ProjectCurrencyCode: string
  Title: Project Currency Code

  Read Only: true

  Maximum Length: 15

  Default Value: USD

  The code for the currency used in the project. The currency code is a three-letter ISO code associated with a currency.
• ProjectId: integer (int64)
  Title: Project ID

  Unique identifier of the project associated with the resource assignment. To identify the project, provide a value only for this attribute, or any one of the Project Number or the Project Name attribute. Project is mandatory when creating an assignment.
• ProjectName: string
  Title: Project Name

  Maximum Length: 240

  Name of the project.
• ProjectNumber: string
  Title: Project Number

  Maximum Length: 25

  Alphanumeric identifier of the project.
• ProjResourceId: integer (int64)
  Title: Project Resource ID

  Read Only: true

  Unique identifier of the project resource.
• ResourceId: integer (int64)
  Title: Resource ID

  Unique identifier of the project enterprise resource.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates who last edited the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the row of data was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the resource who created the row of data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project.",
            "nullable":false,
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"Alphanumeric identifier of the project.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "ProjectId1"
                ]
            },
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project associated with the resource assignment. To identify the project, provide a value only for this attribute, or any one of the Project Number or the Project Name attribute. Project is mandatory when creating an assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Display name of the resource.",
            "nullable":false,
            "x-queryable":true
        },
        "ProjectCurrencyCode":{
            "title":"Project Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The code for the currency used in the project. The currency code is a three-letter ISO code associated with a currency.",
            "nullable":false,
            "readOnly":true,
            "default":"USD",
            "x-queryable":true
        },
        "ExpenseAmount":{
            "title":"Expense Amount",
            "type":"number",
            "description":"Amount allocated in the project for the expense resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Unique identifier of the project enterprise resource.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "ProjResourceId":{
            "title":"Project Resource ID",
            "type":"integer",
            "description":"Unique identifier of the project resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the record was last edited.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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 a project expense resource 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/projectExpenseResources

Request Body Example

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

{
"ExpenseAmount": 2500
}

Response Body Example

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

{
"ProjResourceId": 300100211649582,
"ProjectId": 300100211613856,
"ResourceId": 300100033414520,
"Name": "Construction",
"ExpenseAmount": 2500,
"CreatedBy": "Carlton.Baugh",
"CreationDate": "2020-12-09T06:43:45+00:00",
"LastUpdatedBy": "Carlton.Baugh",
"LastUpdateDate": "2020-12-09T06:50:00+00:00",
"ProjectCurrencyCode": "USD",
"ProjectName": "test 1207 1124",
"ProjectNumber": "test 1207 1124",
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectExpenseResources/300100211649582",
"name": "projectExpenseResources",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectExpenseResources/300100211649582",
"name": "projectExpenseResources",
"kind": "item"
}
]
}

Back to Top