Jump to

• Request
• Response
• Examples

Update one serial attribute flexfield

patch

/fscmRestApi/resources/11.13.18.05/receivingReceiptTransactionRequests/{InterfaceTransactionId}/child/serialItemSerials/{serialItemSerialsUniqID}/child/serialAttributesDFF/{serialAttributesDFFUniqID}

Request

Path Parameters

• InterfaceTransactionId(required): integer(int64)
  Value that uniquely identifies the interfaced receipt transaction line request.
• serialAttributesDFFUniqID(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• serialItemSerialsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Serials for Serial Items resource and used to uniquely identify an instance of Serials for Serial Items. The client should not generate the hash key value. Instead, the client should query on the Serials for Serial Items collection resource in order to navigate to a specific instance of Serials for Serial Items to get the hash key.

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 serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Descriptive flexfield context display value for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control.
• FromSerialNumber: string
  Maximum Length: 80
• TransactionInterfaceId: integer (int64)

{
    "type":"object",
    "properties":{
        "TransactionInterfaceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield context display value for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control.",
            "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 serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control.",
            "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 : receivingReceiptTransactionRequests-serialItemSerials-serialAttributesDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Descriptive flexfield context display value for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control.
• FromSerialNumber: string
  Maximum Length: 80
• links: array Links
  Title: Links

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

{
    "type":"object",
    "properties":{
        "TransactionInterfaceId":{
            "type":"integer",
            "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"
            }
        },
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield context display value for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control.",
            "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
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for serial attributes. This attribute is applicable when the warehouse places the item under lot and serial control.",
            "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

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 serial attribute flexfield.

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/receivingReceiptTransactionRequests/InterfaceTransactionId/child/serialItemSerials/CompositePrimaryKey/child/serialAttributesDFF/CompositePrimaryKey"

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.

{
    "newseg": "GlobalSeg",
    "newctxseg": "CSS"
}

Example Response Body

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

{
    "TransactionInterfaceId": 300100169538375,
    "FromSerialNumber": "E-180659",
    "_Ser_2DGlob": null,
    "newseg": "GlobalSeg",
    "__FLEX_Context": "newctx",
    "__FLEX_Context_DisplayValue": "newctx",
    "newctxseg": "CSS",
   "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169630413/child/serialItemSerials/00020000000EACED00057708000110F0840202CF00000008442D313830363539/child/serialAttributesDFF/00020000000EACED00057708000110F0840202CF00000008442D313830363539",
            "name": "serialAttributesDFF",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169630413/child/serialItemSerials/00020000000EACED00057708000110F0840202CF00000008442D313830363539/child/serialAttributesDFF/00020000000EACED00057708000110F0840202CF00000008442D313830363539",
            "name": "serialAttributesDFF",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169630413/child/serialItemSerials/00020000000EACED00057708000110F0840202CF00000008442D313830363539",
            "name": "serialItemSerials",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169630413/child/serialItemSerials/00020000000EACED00057708000110F0840202CF00000008442D313830363539/child/serialAttributesDFF/00020000000EACED00057708000110F0840202CF00000008442D313830363539/lov/LVVO___FLEX_Context",
            "name": "LVVO___FLEX_Context",
            "kind": "collection"
        }
    ]
}

Back to Top