Create barcode data identifiers
/fscmRestApi/resources/11.13.18.05/inventoryBarcodeFormats/{HeaderId}/child/dataIdentifierConfigurations
Request
-
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=
-
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.
- application/json
object
-
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(required): 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(required): 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(required): boolean
Maximum Length:
1
Indicates if a GS1 group separator is used to specify the end of the data element. -
HeaderId(required): 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
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Response
- application/json
Default Response
-
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.
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. -
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. -
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.
array
Links
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.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
- LinesDFF
-
Parameters:
- HeaderId:
$request.path.HeaderId
- LineId:
$request.path.LineId
- HeaderId:
Examples
This example describes how to create a barcode data identifier for an inventory barcode format.
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/inventoryBarcodeFormats/HeaderId/child/dataIdentifierConfigurations"
For example, the following command creates barcode data identifiers for an inventory barcode format with a header identifier 300100596187556:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596187556/child/dataIdentifierConfigurations"
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.
{ "DataIdentifier": "S+", "DataIdentifierDescription": "Serial number", "FieldName": "Serial number", "DataLengthTypeName": "Variable", "DataLength": null, "GroupSeparatorFlag": false, "Delimiter": "|", "DataTypeName": "Text", "DateFormat": null, "IncludesCheckDigitFlag": false }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "HeaderId": 300100596187556, "LineId": 300100596168540, "DataIdentifier": "S+", "DataIdentifierDescription": "Serial number", "FieldCode": "ORA_SERIAL", "FieldName": "Serial number", "DataLengthType": "ORA_VARIABLE", "DataLengthTypeName": "Variable", "DataLength": null, "GroupSeparatorFlag": false, "Delimiter": "|", "DataType": "ORA_TEXT", "DataTypeName": "Text", "DateFormat": null, "IncludesCheckDigitFlag": false, "CreationDate": "2024-02-08T23:14:48+00:00", "CreatedBy": "SCMOPERATIONS", "LastUpdatedBy": "SCMOPERATIONS", "LastUpdateDate": "2024-02-08T23:14:48.112+00:00", "LastUpdateLogin": "0F4AD417A518C757E063726515ACABAF", "ObjectVersionNumber": 1, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596187556/child/dataIdentifierConfigurations/300100596168540", "name": "dataIdentifierConfigurations", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596187556/child/dataIdentifierConfigurations/300100596168540", "name": "dataIdentifierConfigurations", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596187556", "name": "inventoryBarcodeFormats", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596187556/child/dataIdentifierConfigurations/300100596168540/child/LinesDFF", "name": "LinesDFF", "kind": "collection" } ] }