REST API for Oracle Fusion Cloud SCM

Update one flexfield

patch

/fscmRestApi/resources/11.13.18.05/subinventories/{subinventoriesUniqID}/child/subinventoriesDFF/{subinventoriesDFFUniqID}

Request

Path Parameters

subinventoriesDFFUniqID(required): string

This is the hash key of the attributes which make up the composite key--- OrganizationId and SecondaryInventoryName ---for the Flexfields resource and used to uniquely identify an instance of Flexfields. The client should not generate the hash key value. Instead, the client should query on the Flexfields collection resource with a filter on the primary key values in order to navigate to a specific instance of Flexfields.

For example: subinventoriesDFF?q=OrganizationId=<value1>;SecondaryInventoryName=<value2>
subinventoriesUniqID(required): string

This is the hash key of the attributes which make up the composite key--- OrganizationId and SecondaryInventoryName ---for the Subinventories resource and used to uniquely identify an instance of Subinventories. The client should not generate the hash key value. Instead, the client should query on the Subinventories collection resource with a filter on the primary key values in order to navigate to a specific instance of Subinventories.

For example: subinventories?q=OrganizationId=<value1>;SecondaryInventoryName=<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

Root Schema : schema

Type: object

Show Source

__FLEX_Context: string

Title: Source Type

Maximum Length: 30

Descriptive flexfield context name for subinventories.
__FLEX_Context_DisplayValue: string

Title: Source Type

Descriptive flexfield context display value for subinventories.

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Source Type",
            "type":"string",
            "description":"Descriptive flexfield context display value for subinventories.",
            "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":"Source Type",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for subinventories.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":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"
                }
            }
        }
    }
}

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 : subinventories-subinventoriesDFF-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Source Type

Maximum Length: 30

Descriptive flexfield context name for subinventories.
__FLEX_Context_DisplayValue: string

Title: Source Type

Descriptive flexfield context display value for subinventories.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrganizationId: integer (int64)

Value that uniquely identifies the inventory organization.
SecondaryInventoryName: string

Maximum Length: 10

Name of the subinventory.

{
    "type":"object",
    "properties":{
        "SecondaryInventoryName":{
            "maxLength":10,
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Source Type",
            "type":"string",
            "description":"Descriptive flexfield context display value for subinventories.",
            "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":"Source Type",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for subinventories.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":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%3D401%2CBind_DescriptiveFlexfieldCode%3DINV_SECONDARY_INVENTORIES

The following properties are defined on the LOV link relation:

Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
Display Attribute: Name, Description

LVVO___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

finder: ValidValuesFinder%3BBind_ApplicationId%3D401%2CBind_DescriptiveFlexfieldCode%3DINV_SECONDARY_INVENTORIES

Sets the flexfield context for the subinventory.

The following properties are defined on the LOV link relation:

Source Attribute: __FLEX_Context; Target Attribute: ContextCode
Display Attribute: Name

Examples

This example describes how to update one descriptive flexfield in one subinventory.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/subinventories/subinventoriesUniqID/child/subinventoriesDFF/subinventoriesDFFUniqID"

For example, the following command updates descriptive flexfield 00020000000EACED0005770800000000000000CF000000084142435355423031 in subinventory 00020000000EACED0005770800000000000000CF000000084142435355423031:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/subinventoriesDFF/00020000000EACED0005770800000000000000CF000000084142435355423031

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
            "_BI_2DGlobSeg_2DSub": "BI-val2",
            "_zBIASubInvDFF": "zBIA-2",
            "__FLEX_Context": "SubInv_DFF46210",
            "__FLEX_Context_DisplayValue": "SubInv_DFF46210",
            "_LPN_cap": "101",
            "_Temp": "80"
            }

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "OrganizationId": 207,
    "SecondaryInventoryName": "ABCSUB01",
    "_BI_2DGlobSeg_2DSub": "BI-val2",
    "_zBIASubInvDFF": "zBIA-2",
    "__FLEX_Context": "SubInv_DFF46210",
    "__FLEX_Context_DisplayValue": "SubInv_DFF46210",
    "_LPN_cap": "101",
    "_Temp": "80",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/subinventoriesDFF/00020000000EACED0005770800000000000000CF000000084142435355423031",
            "name": "subinventoriesDFF",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/subinventoriesDFF/00020000000EACED0005770800000000000000CF000000084142435355423031",
            "name": "subinventoriesDFF",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031",
            "name": "subinventories",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/subinventoriesDFF/00020000000EACED0005770800000000000000CF000000084142435355423031/lov/LVVO___FLEX_Context",
            "name": "LVVO___FLEX_Context",
            "kind": "collection"
        }
    ]
}