Jump to

• Request
• Response
• Examples

Create flexfields

post

/fscmRestApi/resources/11.13.18.05/inventoryItemSerialNumbers/{inventoryItemSerialNumbersUniqID}/child/serialAttributeDFF

Request

Path Parameters

• inventoryItemSerialNumbersUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- OrganizationId, InventoryItemId and SerialNumber ---for the Inventory Item Serial Numbers resource and used to uniquely identify an instance of Inventory Item Serial Numbers. The client should not generate the hash key value. Instead, the client should query on the Inventory Item Serial Numbers collection resource with a filter on the primary key values in order to navigate to a specific instance of Inventory Item Serial Numbers.
  
  For example: inventoryItemSerialNumbers?q=OrganizationId=<value1>;InventoryItemId=<value2>;SerialNumber=<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.
• 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

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 serial number attributes.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• CurrentOrganizationId: integer (int64)
  Value that uniquely identifies the organization.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Serial number that identifies the inventory item.

{
    "type":"object",
    "properties":{
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Serial number that identifies the inventory item.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":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"
                }
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "CurrentOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for serial number 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_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(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.

Body ()

Root Schema : inventoryItemSerialNumbers-serialAttributeDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

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

  The link relations associated with the resource instance.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Serial number that identifies the inventory item.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Serial number that identifies the inventory item.",
            "nullable":false,
            "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 item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "CurrentOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "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 serial number 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_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_SERIAL_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_SERIAL_ATTRIBUTES

List of values that the user uses to set the context value for the attributes of the serial number 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 create flexfields.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/inventoryItemSerialNumbersUniqID/child/serialAttributeDFF"

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 creates.

{
	"OrganizationId":207,
	"InventoryItemId":663915,
	"SerialNumber":"SS20181206_2",
	"serialAttributeDFF":[{
		"_Ser_2DGlob":"G1"
	}]
}

Example Response Body

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

{
	"OrganizationId": 207,
	"OrganizationCode": "M1",
	"OrganizationName": "Tall Manufacturing",
	"InventoryItemId": 663915,
	"ItemNumber": "INV-102",
	"ItemDescription": "Serial @ Receipt Item",
	"SerialNumber": "SS20181206_2",
	"SubinventoryCode": null,
	"LocatorId": null,
	"Locator": null,
	"LotNumber": null,
	"Revision": null,
	"StatusId": null,
	"StatusCode": null,
	"UsageCode": "1",
	"Usage": "Defined but not used",
	"ShippedDate": null,
	"ReceiptDate": null,
	"Allocated": "No",
	"Reserved": "No",
	"Supplier": null,
	"SupplierLot": null,
	"SupplierSerialNumber": null,
	"serialAttributeDFF": [
	{
		"InventoryItemId": 663915,
		"SerialNumber": "SS20181206_2",
		"CurrentOrganizationId": 207,
		"_Ser_2DGlob": "G1",
		"__FLEX_Context": null,
		"__FLEX_Context_DisplayValue": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F32/child/serialAttributeDFF/00030000000EACED0005770800000000000A216B0000000C535332303138313230365F320000000EACED0005770800000000000000CF",
			"name": "serialAttributeDFF",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F32/child/serialAttributeDFF/00030000000EACED0005770800000000000A216B0000000C535332303138313230365F320000000EACED0005770800000000000000CF",
			"name": "serialAttributeDFF",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F32",
			"name": "inventoryItemSerialNumbers",
			"kind": "item"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F32/child/serialAttributeDFF/00030000000EACED0005770800000000000A216B0000000C535332303138313230365F320000000EACED0005770800000000000000CF/lov/LVVO___FLEX_Context",
			"name": "LVVO___FLEX_Context",
			"kind": "collection"
		}
		],
	}
	],
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F32",
		"name": "inventoryItemSerialNumbers",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F32",
		"name": "inventoryItemSerialNumbers",
		"kind": "item"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F32/lov/SerialSupplierVA",
		"name": "SerialSupplierVA",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F32/lov/ItemVA",
		"name": "ItemVA",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F32/lov/AccessibleOrganizationVA",
		"name": "AccessibleOrganizationVA",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F32/child/serialAttributeDFF",
		"name": "serialAttributeDFF",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/inventoryItemSerialNumbers/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216B0000000C535332303138313230365F32/child/serialStandardDFF",
		"name": "serialStandardDFF",
		"kind": "collection"
	}
	],
}

Back to Top