Jump to

• Request
• Response
• Examples

Update a descriptive flex field

patch

/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentsDFF/{planComponentsDFFUniqID}

Request

Path Parameters

• planComponentsDFFUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanComponentId and OrgId ---for the Plan Component Descriptive Flex Fields resource and used to uniquely identify an instance of Plan Component Descriptive Flex Fields. The client should not generate the hash key value. Instead, the client should query on the Plan Component Descriptive Flex Fields collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Component Descriptive Flex Fields.
  
  For example: planComponentsDFF?q=PlanComponentId=<value1>;OrgId=<value2>
• planComponentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanComponentId and OrgId ---for the Plan Components resource and used to uniquely identify an instance of Plan Components. The client should not generate the hash key value. Instead, the client should query on the Plan Components collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Components.
  
  For example: planComponents?q=PlanComponentId=<value1>;OrgId=<value2>

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

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  This field represents the flex context segment code for the plan component. It determines which context-sensitive segments are displayed.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  This field represents the flex context segment display name for the plan component. It determines which context-sensitive segments are displayed.

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"This field represents the flex context segment display name for the  plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"This field represents the flex context segment code for the plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : planComponents-planComponentsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  This field represents the flex context segment code for the plan component. It determines which context-sensitive segments are displayed.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  This field represents the flex context segment display name for the plan component. It determines which context-sensitive segments are displayed.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrgId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit organisation.
• PlanComponentId: integer (int64)
  The unique identifier for the plan component record within a business unit.

{
    "type":"object",
    "properties":{
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit organisation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier for the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"This field represents the flex context segment display name for the  plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"This field represents the flex context segment code for the plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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."
        }
    }
}

Links

LVVO_V___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

• finder: ValidValuesFinder%3BBind_ApplicationId%3D283%2CBind_DescriptiveFlexfieldCode%3DCN_PLAN_COMPONENTS_DFF

LVVO___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

• finder: ValidValuesFinder%3BBind_ApplicationId%3D283%2CBind_DescriptiveFlexfieldCode%3DCN_PLAN_COMPONENTS_DFF

Back to Top

Examples

The following example shows how to update a descriptive flex field by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/planComponents/00020000000EACED00057708000110F07F4ABECA0000000EACED0005770800000000000000CC/child/planComponentsDFF/00020000000EACED00057708000110F07F4ABECA0000000EACED0005770800000000000000CC

Example of Request Body

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

{ 
"Plan__Component__DFF" : "Only valid for key sales reps"
}

Example of Response Body

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

{
  "PlanComponentId": 300100090511050,
  "OrgId": 204,
  "_Plan__Component__DFF": "Only valid for key sales reps",
  "usage": "Incentive",
  "status": null,
  "newDfff": null,
  "newDfffNumber": null,
  "newDfffDate": null,
  "newDfffWithNewFile": null,
  "newDff25april": null,
  "dffPc170520122852885": null,
  "dffPc170529142616148": null,
  "dffPc170606120644026": null,
  "__FLEX_Context": null,
  "__FLEX_Context_DisplayValue": null,
  "links": [
    ...
  ]
}

Back to Top