Jump to

• Request
• Response

Update one serial information

patch

/fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/{HeaderInterfaceId}/child/lines/{InterfaceTransactionId}/child/serialItemSerials/{serialItemSerialsUniqID}

Request

Path Parameters

• HeaderInterfaceId(required): integer(int64)
  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=
• InterfaceTransactionId(required): integer(int64)
  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--- TransactionInterfaceId and FromSerialNumber ---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 with a filter on the primary key values in order to navigate to a specific instance of Serials for Serial Items.
  
  For example: serialItemSerials?q=TransactionInterfaceId=<value1>;FromSerialNumber=<value2>

Header Parameters

• Metadata-Context: string
  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: string
  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

• FromSerialNumber: string
  Maximum Length: 80

  Starting serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.
• ProductTransactionId: integer (int64)
  Value that uniquely identifies the receipt line request.
• serialAttributesDFF: array serialAttributesDFF
• serialNumbersDFF: array serialNumbersDFF
• ToSerialNumber: string
  Maximum Length: 80

  Ending serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.
• VendorSerialNumber: string
  Maximum Length: 80

  Supplier serial number for the serial range of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.

{
    "type":"object",
    "properties":{
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Starting serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.",
            "nullable":false
        },
        "ProductTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt line request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ToSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Ending serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.",
            "nullable":true
        },
        "VendorSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Supplier serial number for the serial range of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.",
            "nullable":true
        },
        "serialAttributesDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/receivingReceiptRequests-lines-serialItemSerials-serialAttributesDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "serialNumbersDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/receivingReceiptRequests-lines-serialItemSerials-serialNumbersDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : serialAttributesDFF

Type: array

Show Source

• Array of: object receivingReceiptRequests-lines-serialItemSerials-serialAttributesDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/receivingReceiptRequests-lines-serialItemSerials-serialAttributesDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : serialNumbersDFF

Type: array

Show Source

• Array of: object receivingReceiptRequests-lines-serialItemSerials-serialNumbersDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/receivingReceiptRequests-lines-serialItemSerials-serialNumbersDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : receivingReceiptRequests-lines-serialItemSerials-serialAttributesDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• FromSerialNumber: string
  Maximum Length: 80
• TransactionInterfaceId: integer (int64)

{
    "type":"object",
    "properties":{
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "TransactionInterfaceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "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"
                }
            }
        }
    }
}

Nested Schema : receivingReceiptRequests-lines-serialItemSerials-serialNumbersDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• FromSerialNumber: string
  Maximum Length: 80
• TransactionInterfaceId: integer (int64)

{
    "type":"object",
    "properties":{
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "TransactionInterfaceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "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"
                }
            }
        }
    }
}

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 : receivingReceiptRequests-lines-serialItemSerials-item-response

Type: object

Show Source

• FromSerialNumber: string
  Maximum Length: 80

  Starting serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProductTransactionId: integer (int64)
  Value that uniquely identifies the receipt line request.
• serialAttributesDFF: array serialAttributesDFF
• serialNumbersDFF: array serialNumbersDFF
• ToSerialNumber: string
  Maximum Length: 80

  Ending serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.
• TransactionInterfaceId: integer (int64)
  Value that uniquely identifies the serial for the receipt line request.
• VendorSerialNumber: string
  Maximum Length: 80

  Supplier serial number for the serial range of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.

{
    "type":"object",
    "properties":{
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Starting serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt line request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ToSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Ending serial number in a range of serial numbers of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionInterfaceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the serial for the receipt line request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VendorSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Supplier serial number for the serial range of the receipt transaction request. This attribute is applicable when the warehouse places the item under serial control.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "serialAttributesDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/receivingReceiptRequests-lines-serialItemSerials-serialAttributesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "serialNumbersDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/receivingReceiptRequests-lines-serialItemSerials-serialNumbersDFF-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

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 : serialAttributesDFF

Type: array

Show Source

• Array of: object receivingReceiptRequests-lines-serialItemSerials-serialAttributesDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/receivingReceiptRequests-lines-serialItemSerials-serialAttributesDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : serialNumbersDFF

Type: array

Show Source

• Array of: object receivingReceiptRequests-lines-serialItemSerials-serialNumbersDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/receivingReceiptRequests-lines-serialItemSerials-serialNumbersDFF-item-response"
    },
    "x-cardinality":"1"
}

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."
        }
    }
}

Nested Schema : receivingReceiptRequests-lines-serialItemSerials-serialAttributesDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• FromSerialNumber: string
  Maximum Length: 80
• links: array Links
  Title: Links

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

{
    "type":"object",
    "properties":{
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TransactionInterfaceId":{
            "type":"integer",
            "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":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : receivingReceiptRequests-lines-serialItemSerials-serialNumbersDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• FromSerialNumber: string
  Maximum Length: 80
• links: array Links
  Title: Links

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

{
    "type":"object",
    "properties":{
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TransactionInterfaceId":{
            "type":"integer",
            "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":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

serialAttributesDFF

Operation: /fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/{HeaderInterfaceId}/child/lines/{InterfaceTransactionId}/child/serialItemSerials/{serialItemSerialsUniqID}/child/serialAttributesDFF

Parameters:

• HeaderInterfaceId: $request.path.HeaderInterfaceId
• InterfaceTransactionId: $request.path.InterfaceTransactionId
• serialItemSerialsUniqID: $request.path.serialItemSerialsUniqID

serialNumbersDFF

Operation: /fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/{HeaderInterfaceId}/child/lines/{InterfaceTransactionId}/child/serialItemSerials/{serialItemSerialsUniqID}/child/serialNumbersDFF

Parameters:

• HeaderInterfaceId: $request.path.HeaderInterfaceId
• InterfaceTransactionId: $request.path.InterfaceTransactionId
• serialItemSerialsUniqID: $request.path.serialItemSerialsUniqID

Back to Top