Jump to

• Request
• Response
• Examples

Update one flexfield

patch

/fscmRestApi/resources/11.13.18.05/inventoryItemLots/{inventoryItemLotsUniqID}/child/lotAttributeDFF/{lotAttributeDFFUniqID}

Request

Path Parameters

• inventoryItemLotsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- OrganizationId, InventoryItemId and LotNumber ---for the Inventory Item Lots resource and used to uniquely identify an instance of Inventory Item Lots. The client should not generate the hash key value. Instead, the client should query on the Inventory Item Lots collection resource with a filter on the primary key values in order to navigate to a specific instance of Inventory Item Lots.
  
  For example: inventoryItemLots?q=OrganizationId=<value1>;InventoryItemId=<value2>;LotNumber=<value3>
• lotAttributeDFFUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- InventoryItemId, OrganizationId and LotNumber ---for the Flexfields for Lot Attributes resource and used to uniquely identify an instance of Flexfields for Lot Attributes. The client should not generate the hash key value. Instead, the client should query on the Flexfields for Lot Attributes collection resource with a filter on the primary key values in order to navigate to a specific instance of Flexfields for Lot Attributes.
  
  For example: lotAttributeDFF?q=InventoryItemId=<value1>;OrganizationId=<value2>;LotNumber=<value3>

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 Value

  Maximum Length: 30

  Descriptive flexfield context name for lot attributes.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "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":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for lot attributes.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "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":"HIDDEN"
            },
            "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 : inventoryItemLots-lotAttributeDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for lot attributes.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotNumber: string
  Title: Lot

  Maximum Length: 80

  Number that identifies the lot.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization.

{
    "type":"object",
    "properties":{
        "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 organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot",
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the lot.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "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":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for lot attributes.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "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":"HIDDEN"
            },
            "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_LOT_ATTRIBUTES

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_LOT_ATTRIBUTES

List of values that the user uses to set the context value for the attributes of the lot that the descriptive flexfield references.

The following properties are defined on the LOV link relation:

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

Back to Top

Examples

This example describes how to update one flexfield.

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resource using the parent resource.

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

For example, this command patches attribute flexfields where the inventory item lots unique identifier is 00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A00000006533338303132 from the parent resource:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d '
request payload'  "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A00000006533338303132"

Example 1 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. This request body is used with the parent resource.

{
	"lotAttributeDFF":[{
		"_zBIALotAttDFF":"zbi2"
	}]
}

Example 1 Response Body

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

{
	"OrganizationId": 207,
	"OrganizationCode": "M1",
	"OrganizationName": "Tall Manufacturing",
	"InventoryItemId": 663914,
	"ItemNumber": "INV-101",
	"ItemDescription": "Lot Item",
	"LotNumber": "SF20181206_2",
	"ParentLotNumber": null,
	"ActiveLotCode": "2",
	"ActiveLot": "Yes",
	"OriginationTypeCode": "0",
	"OriginationType": "Lot master",
	"StatusId": 1,
	"StatusCode": "Active",
	"Grade": null,
	"ExpirationActionCode": null,
	"ExpirationAction": null,
	"OriginationDate": "2018-12-06T23:34:53+00:00",
	"ExpirationDate": null,
	"MaturityDate": "2018-12-06T23:34:53+00:00",
	"ExpirationActionDate": null,
	"HoldUntilDate": "2018-12-06T23:34:53+00:00",
	"RetestDate": null,
	"lotAttributeDFF": [
	{
		"InventoryItemId": 663914,
		"OrganizationId": 207,
		"LotNumber": "SF20181206_2",
		"_Lot_2DGlob": "LG-A-1",
		"_BI_2DGlobSeg_2DLAttr": null,
		"_zBIALotAttDFF": "zbi2",
		"__FLEX_Context": "Lot-Ctx",
		"__FLEX_Context_DisplayValue": "Lot-Ctx",
		"_Lot_2DSeg1": "LS1",
		"_Lot_2DSeg2": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32/child/lotAttributeDFF/00030000000EACED0005770800000000000A216A0000000EACED0005770800000000000000CF0000000C534632303138313230365F32",
			"name": "lotAttributeDFF",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32/child/lotAttributeDFF/00030000000EACED0005770800000000000A216A0000000EACED0005770800000000000000CF0000000C534632303138313230365F32",
			"name": "lotAttributeDFF",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32",
			"name": "inventoryItemLots",
			"kind": "item"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32/child/lotAttributeDFF/00030000000EACED0005770800000000000A216A0000000EACED0005770800000000000000CF0000000C534632303138313230365F32/lov/LVVO___FLEX_Context",
			"name": "LVVO___FLEX_Context",
			"kind": "collection"
		}
		],
	}
	],
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32",
		"name": "inventoryItemLots",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32",
		"name": "inventoryItemLots",
		"kind": "item"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32/lov/ActiveLotLookupVA",
		"name": "ActiveLotLookupVA",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32/lov/ItemVA",
		"name": "ItemVA",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32/lov/AccessibleOrganizationVA",
		"name": "AccessibleOrganizationVA",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32/lov/LotExpirationActionVA",
		"name": "LotExpirationActionVA",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32/lov/OriginationTypeLookupVA",
		"name": "OriginationTypeLookupVA",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32/lov/LotGradeVA",
		"name": "LotGradeVA",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32/lov/InventoryStatusVA",
		"name": "InventoryStatusVA",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F32/child/lotAttributeDFF",
		"name": "lotAttributeDFF",
		"kind": "collection"
	}
	],
}

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource using the DFF child resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  
"https://servername/fscmRestApi/resources/version/inventoryItemLots/inventoryItemLotsUniqID/child/lotAttributeDFF/lotAttributeDFFUniqID"

For example, this command patches attribute flexfields where the lotAttributeDFFUniqID is 00030000000EACED0005770800000000000A216A0000000EACED0005770800000000000000CF00000006533338303132:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d '
request payload'  "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A00000006533338303132/child/lotAttributeDFF/00030000000EACED0005770800000000000A216A0000000EACED0005770800000000000000CF00000006533338303132"

Example 2 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.

{
	"_Lot_2DGlob": "g1"
}

Example 2 Response Body

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

{
	"InventoryItemId": 663914,
	"OrganizationId": 207,
	"LotNumber": "S38012",
	"_Lot_2DGlob": "g1",
	"_BI_2DGlobSeg_2DLAttr": null,
	"_zBIALotAttDFF": null,
	"__FLEX_Context": null,
	"__FLEX_Context_DisplayValue": null,
	"links": [
	{
		"rel": "self",
		"href": "http://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A00000006533338303132/child/lotAttributeDFF/00030000000EACED0005770800000000000A216A0000000EACED0005770800000000000000CF00000006533338303132",
		"name": "lotAttributeDFF",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
		}
	},
	{
		"rel": "canonical",
		"href": "http://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A00000006533338303132/child/lotAttributeDFF/00030000000EACED0005770800000000000A216A0000000EACED0005770800000000000000CF00000006533338303132",
		"name": "lotAttributeDFF",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "http://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A00000006533338303132",
		"name": "inventoryItemLots",
		"kind": "item"
	},
	{
		"rel": "lov",
		"href": "http://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A00000006533338303132/child/lotAttributeDFF/00030000000EACED0005770800000000000A216A0000000EACED0005770800000000000000CF00000006533338303132/lov/LVVO___FLEX_Context",
		"name": "LVVO___FLEX_Context",
		"kind": "collection"
	}
	],
}

Back to Top