Update a descriptive flexfield for a project cost
patch
/fscmRestApi/resources/11.13.18.05/projectCosts/{projectCostsUniqID}/child/ProjectCostsDFF/{ExpenditureItemId}
Request
Path Parameters
-
ExpenditureItemId(required): integer(int64)
The identifier of the project cost transaction.
-
projectCostsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Project Costs resource and used to uniquely identify an instance of Project Costs. The client should not generate the hash key value. Instead, the client should query on the Project Costs collection resource in order to navigate to a specific instance of Project Costs 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
Root Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
Code that identifies the context for the segments of the project expenditure items. -
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
Name of the context for the segments of the project expenditure items.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : projectCosts-ProjectCostsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
Code that identifies the context for the segments of the project expenditure items. -
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
Name of the context for the segments of the project expenditure items. -
ExpenditureItemId: integer
(int64)
Title:
Transaction Number
The identifier of the project cost transaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D10036%2CBind_DescriptiveFlexfieldCode%3DPJC_EXP_ITEMS_DESC_FLEX
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
- Display Attribute: Name, Description
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D10036%2CBind_DescriptiveFlexfieldCode%3DPJC_EXP_ITEMS_DESC_FLEX
The list of valid contexts applicable for the project expenditure item descriptive flexfields.
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context; Target Attribute: ContextCode
- Display Attribute: Name
- finder:
Examples
The following example shows how to update a descriptive flexfield for a project cost 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/projectCosts/17285/child/ProjectCostsDFF/17285
Request Body Example
The following shows an example of the request body in JSON format.
{"City": "New York" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "ExpenditureItemId": 17285, "City": "New York", "__FLEX_Context": null, "__FLEX_Context_DisplayValue": null, "links": [ { "rel": "self", "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/projectCosts/17285/child/ProjectCostsDFF/17285", "name": "ProjectCostsDFF", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/projectCosts/17285/child/ProjectCostsDFF/17285", "name": "ProjectCostsDFF", "kind": "item" }, { "rel": "parent", "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/projectCosts/17285", "name": "projectCosts", "kind": "item" } ] }