Update one inventory barcode format
patch
/fscmRestApi/resources/11.13.18.05/inventoryBarcodeFormats/{HeaderId}
Request
Path Parameters
-
HeaderId(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=
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:
Show Source
object
-
BarcodeFormatDescription: string
Maximum Length:
100
Description of the barcode format. -
BarcodeIdentifierPrefix: string
Maximum Length:
10
Prefix of the barcode that will be used to identify the barcode format. -
dataIdentifierConfigurations: array
Barcode Data Identifiers
Title:
Barcode Data Identifiers
The format of encoded data elements of a barcode, including how it should be parsed and mapped when the barcode is scanned. -
HeadersDFF: array
HeadersDFF
-
IncludesCheckDigitFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the last digit of the barcode data is a check digit, and the last character of the value will be excluded while parsing. If false, then the last digit of the barcode data isn't a check digit. The default value is false. -
RetainPrefixFlag: boolean
Maximum Length:
1
Indicates if the prefix of the barcode should be retained or removed before parsing the barcode data. -
Status: string
Maximum Length:
1
Status of the barcode format.
Nested Schema : Barcode Data Identifiers
Type:
array
Title:
Barcode Data Identifiers
The format of encoded data elements of a barcode, including how it should be parsed and mapped when the barcode is scanned.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
DataElementSequenceNumber: integer
(int32)
Indicates the sequence number of a data element in a data identifier when the data identifier contains multiple data elements.
-
DataIdentifierDescription: string
Maximum Length:
50
Description of the data identifier. -
DataLength: integer
(int32)
Indicates the number of characters of the barcode data.
-
DataLengthType: string
Maximum Length:
30
Abbreviation that identifies if the number of characters of the barcode data is fixed or variable. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FIELD_LEN_TYPE. -
DataLengthTypeName: string
Maximum Length:
255
Indicates if the number of characters of the barcode data is fixed or variable. -
DataType: string
Maximum Length:
30
Abbreviation that identifies the data type of the barcode data. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FLD_DATA_TYPE. -
DataTypeName: string
Maximum Length:
255
Indicates the data type of the barcode data. -
DateFormat: string
Maximum Length:
25
Indicates the date format of the barcode data if the data type is date. -
Delimiter: string
Maximum Length:
25
Indicates the text that's used to specify the end of the data element. -
FieldCode: string
Maximum Length:
30
Abbreviation that identifies the field name to which barcode data should be mapped. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FIELDS. -
FieldName: string
Maximum Length:
255
Indicates the field name to which barcode data should be mapped. -
GroupSeparatorFlag: boolean
Maximum Length:
1
Indicates if a GS1 group separator is used to specify the end of the data element. -
HeaderId: integer
(int64)
Value that uniquely identifies the barcode format.
-
IncludesCheckDigitFlag: boolean
Maximum Length:
1
Indicates if the last digit of the barcode data is a check digit. -
LinesDFF: array
LinesDFF
-
MultiDataElementFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then it indicates that the data identifier contains multiple data elements. If false, then the data identifier doesn't contain multiple data elements. -
RetainDataIdentifierFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then it indicates that the data identifier will be retained in the barcode data while parsing and included as part of the data element. If false, then it indicates that the data identifier won't be retained. -
RetainDelimiterFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then it indicates that the delimiter will be retained in the barcode data while parsing and included as part of the data identifier. If false, then it indicates that the delimiter won't be retained.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Nested Schema : inventoryBarcodeFormats-HeadersDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
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.
Root Schema : inventoryBarcodeFormats-item-response
Type:
Show Source
object
-
BarcodeFormatDescription: string
Maximum Length:
100
Description of the barcode format. -
BarcodeFormatName: string
Maximum Length:
20
Name of the barcode format. -
BarcodeIdentifierPrefix: string
Maximum Length:
10
Prefix of the barcode that will be used to identify the barcode format. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the barcode format. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the barcode format. -
dataIdentifierConfigurations: array
Barcode Data Identifiers
Title:
Barcode Data Identifiers
The format of encoded data elements of a barcode, including how it should be parsed and mapped when the barcode is scanned. -
HeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the barcode format. -
HeadersDFF: array
HeadersDFF
-
IncludesCheckDigitFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the last digit of the barcode data is a check digit, and the last character of the value will be excluded while parsing. If false, then the last digit of the barcode data isn't a check digit. The default value is false. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the barcode format. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the barcode format. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login information of the user who most recently updated the barcode format. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Number of times the object row has been updated. This attribute is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
RetainPrefixFlag: boolean
Maximum Length:
1
Indicates if the prefix of the barcode should be retained or removed before parsing the barcode data. -
Status: string
Maximum Length:
1
Status of the barcode format.
Nested Schema : Barcode Data Identifiers
Type:
array
Title:
Barcode Data Identifiers
The format of encoded data elements of a barcode, including how it should be parsed and mapped when the barcode is scanned.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBarcodeFormats-dataIdentifierConfigurations-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the data identifier configuration. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the data identifier configuration. -
DataElementSequenceNumber: integer
(int32)
Indicates the sequence number of a data element in a data identifier when the data identifier contains multiple data elements.
-
DataIdentifier: string
Maximum Length:
10
Prefix of the encoded barcode data that indicates the meaning of the barcode data. -
DataIdentifierDescription: string
Maximum Length:
50
Description of the data identifier. -
DataLength: integer
(int32)
Indicates the number of characters of the barcode data.
-
DataLengthType: string
Maximum Length:
30
Abbreviation that identifies if the number of characters of the barcode data is fixed or variable. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FIELD_LEN_TYPE. -
DataLengthTypeName: string
Maximum Length:
255
Indicates if the number of characters of the barcode data is fixed or variable. -
DataType: string
Maximum Length:
30
Abbreviation that identifies the data type of the barcode data. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FLD_DATA_TYPE. -
DataTypeName: string
Maximum Length:
255
Indicates the data type of the barcode data. -
DateFormat: string
Maximum Length:
25
Indicates the date format of the barcode data if the data type is date. -
Delimiter: string
Maximum Length:
25
Indicates the text that's used to specify the end of the data element. -
FieldCode: string
Maximum Length:
30
Abbreviation that identifies the field name to which barcode data should be mapped. A list of acceptable values is defined in the lookup ORA_INV_BARCODE_FIELDS. -
FieldName: string
Maximum Length:
255
Indicates the field name to which barcode data should be mapped. -
GroupSeparatorFlag: boolean
Maximum Length:
1
Indicates if a GS1 group separator is used to specify the end of the data element. -
HeaderId: integer
(int64)
Value that uniquely identifies the barcode format.
-
IncludesCheckDigitFlag: boolean
Maximum Length:
1
Indicates if the last digit of the barcode data is a check digit. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the data identifier configuration. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the data identifier configuration. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login information of the user who most recently updated the data identifier configuration. -
LineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the data identifier configuration. -
LinesDFF: array
LinesDFF
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MultiDataElementFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then it indicates that the data identifier contains multiple data elements. If false, then the data identifier doesn't contain multiple data elements. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Number of times the object row has been updated. This attribute is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
RetainDataIdentifierFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then it indicates that the data identifier will be retained in the barcode data while parsing and included as part of the data element. If false, then it indicates that the data identifier won't be retained. -
RetainDelimiterFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then it indicates that the delimiter will be retained in the barcode data while parsing and included as part of the data identifier. If false, then it indicates that the delimiter won't be retained.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryBarcodeFormats-dataIdentifierConfigurations-LinesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
LineId: integer
(int64)
Read Only:
true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : inventoryBarcodeFormats-HeadersDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
HeaderId: integer
(int64)
Read Only:
true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- HeadersDFF
-
Parameters:
- HeaderId:
$request.path.HeaderId
- HeaderId:
- dataIdentifierConfigurations
-
Parameters:
- HeaderId:
$request.path.HeaderId
The format of encoded data elements of a barcode, including how it should be parsed and mapped when the barcode is scanned. - HeaderId:
Examples
This example describes how to update one inventory barcode format.
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/inventoryBarcodeFormats/HeaderId"
For example, the following command updates one barcode format with a header
identifier
300100596176436:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436"
Example Request Body
The following example includes the contents of the request body in JSON format to update the Barcode Identifier Prefix attribute. 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.
{ "BarcodeIdentifierPrefix": "#" }
Example Response Body
The following example includes the contents of the response
body in JSON format:
{ "HeaderId": 300100596176436, "BarcodeFormatName": "Custom Barcode Demo", "BarcodeFormatDescription": "Custom Barcode Demo", "BarcodeIdentifierPrefix": "#", "RetainPrefixFlag": false, "Status": "Y", "CreationDate": "2024-02-08T21:47:24+00:00", "CreatedBy": "SCMOPERATIONS", "LastUpdatedBy": "SCMOPERATIONS", "LastUpdateDate": "2024-02-08T22:27:28+00:00", "LastUpdateLogin": "0F48DD532AA3C919E063746415AC3F3A", "ObjectVersionNumber": 2, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436", "name": "inventoryBarcodeFormats", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436", "name": "inventoryBarcodeFormats", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436/child/HeadersDFF", "name": "HeadersDFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436/child/dataIdentifierConfigurations", "name": "dataIdentifierConfigurations", "kind": "collection" } ] }