Update the descriptive flexfields for a project
patch
/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/ProjectDFF/{ProjectId2}
Request
Path Parameters
-
ProjectId(required): integer(int64)
Unique identifier of the project.
-
ProjectId2(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
Context display value of the descriptive flexfield. -
ProjectId: integer
(int64)
Unique identifier of the project.
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.
Root Schema : projectPlans-ProjectDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
Context display value of the descriptive flexfield. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectId: integer
(int64)
Unique identifier of the project.
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%3D10037%2CBind_DescriptiveFlexfieldCode%3DPJF_PROJECTS_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%3D10037%2CBind_DescriptiveFlexfieldCode%3DPJF_PROJECTS_DESC_FLEX
The list of valid descriptive flexfield context values allowed for the selected descriptive flexfield.
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 the descriptive flexfields for a project 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/300100184801843/child/ProjectDFF/300100184801843
Request Body Example
The following shows an example of the request body in JSON format.
{ "textBox": null, "yesNo": "NO", "__FLEX_Context": "Project Context1", "__FLEX_Context_DisplayValue": "Project Context1", "contextSensitiveSegment1": "test2" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "ProjectId": 300100184801843, "textBox": null, "yesNo": "NO", "globalSegmentForProjectDffs": null, "mstrCntrctNbr": null, "__FLEX_Context": "Project Context1", "__FLEX_Context_DisplayValue": "Project Context1", "contextSensitiveSegment1": "test2", "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/ProjectDFF/300100184801843", "name": "ProjectDFF", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/ProjectDFF/300100184801843", "name": "ProjectDFF", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843", "name": "projectPlans", "kind": "item" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/ProjectDFF/300100184801843/lov/LVVO_yesNo", "name": "LVVO_yesNo", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/ProjectDFF/300100184801843/lov/LVVO___FLEX_Context", "name": "LVVO___FLEX_Context", "kind": "collection" } ] }