Create descriptive flexfields for a task
post
/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/TaskDFF
Request
Path Parameters
-
ProjectId(required): integer(int64)
Unique identifier of the project.
-
TaskId(required): integer(int64)
Unique identifier of 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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context display value of the descriptive flexfield. -
ProjElementId: integer
(int64)
Unique identifier of the task. The values is the same as Task ID.
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 : projectPlans-Tasks-TaskDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context display value of the descriptive flexfield. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjElementId: integer
(int64)
Unique identifier of the task. The values is the same as Task ID.
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_TASK_STRUCTURE_DFF
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_TASK_STRUCTURE_DFF
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 create descriptive flexfields for a task by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks//300100184802588/child/TaskDFF
Request Body Example
The following shows an example of the request body in JSON format.
{ "testTextBox": "test2", "testTextArea": "test", "dtestcheckbox": "N", "testnumber": "234", "testdate": "2018-08-08" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "ProjElementId": 300100184802588, "testTextBox": "test2", "testTextArea": "test", "testDropDown": null, "testLov": null, "testPopup": null, "testRadioButton": null, "globalSegmentForTaskDffs": null, "biqaCode": null, "dtestcheckbox": "N", "dhidden": null, "dinlinesearch": null, "dteststaticurl": null, "testnumber": 234, "testdate": "2018-08-08", "testdate2": null, "testdate3": null, "__FLEX_Context": null, "__FLEX_Context_DisplayValue": null, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802588/child/TaskDFF/300100184802588", "name": "TaskDFF", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802588/child/TaskDFF/300100184802588", "name": "TaskDFF", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802588", "name": "Tasks", "kind": "item" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802588/child/TaskDFF/300100184802588/lov/LVVO_testDropDown", "name": "LVVO_testDropDown", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802588/child/TaskDFF/300100184802588/lov/LVVO_testRadioButton", "name": "LVVO_testRadioButton", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802588/child/TaskDFF/300100184802588/lov/LVVO_testPopup", "name": "LVVO_testPopup", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802588/child/TaskDFF/300100184802588/lov/LVVO_dtestcheckbox", "name": "LVVO_dtestcheckbox", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802588/child/TaskDFF/300100184802588/lov/LVVO___FLEX_Context", "name": "LVVO___FLEX_Context", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802588/child/TaskDFF/300100184802588/lov/LVVO_testdate3", "name": "LVVO_testdate3", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802588/child/TaskDFF/300100184802588/lov/LVVO_testLov", "name": "LVVO_testLov", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184802588/child/TaskDFF/300100184802588/lov/LVVO_dhidden", "name": "LVVO_dhidden", "kind": "collection" } ] }