Create inventory barcode formats

post

/fscmRestApi/resources/11.13.18.05/inventoryBarcodeFormats

Request

Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
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 : HeadersDFF
Type: array
Show Source
Nested Schema : schema
Type: object
Show Source
  • Indicates the sequence number of a data element in a data identifier when the data identifier contains multiple data elements.
  • Maximum Length: 10
    Prefix of the encoded barcode data that indicates the meaning of the barcode data.
  • Maximum Length: 50
    Description of the data identifier.
  • Indicates the number of characters of the barcode data.
  • 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.
  • Maximum Length: 255
    Indicates if the number of characters of the barcode data is fixed or variable.
  • 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.
  • Maximum Length: 255
    Indicates the data type of the barcode data.
  • Maximum Length: 25
    Indicates the date format of the barcode data if the data type is date.
  • Maximum Length: 25
    Indicates the text that's used to specify the end of the data element.
  • 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.
  • Maximum Length: 255
    Indicates the field name to which barcode data should be mapped.
  • Maximum Length: 1
    Indicates if a GS1 group separator is used to specify the end of the data element.
  • Value that uniquely identifies the barcode format.
  • Maximum Length: 1
    Indicates if the last digit of the barcode data is a check digit.
  • LinesDFF
  • 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.
  • 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.
  • 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 : LinesDFF
Type: array
Show Source
Nested Schema : inventoryBarcodeFormats-dataIdentifierConfigurations-LinesDFF-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : inventoryBarcodeFormats-item-response
Type: object
Show Source
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 : HeadersDFF
Type: array
Show Source
Nested Schema : inventoryBarcodeFormats-dataIdentifierConfigurations-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the data identifier configuration.
  • Read Only: true
    Date when the user created the data identifier configuration.
  • Indicates the sequence number of a data element in a data identifier when the data identifier contains multiple data elements.
  • Maximum Length: 10
    Prefix of the encoded barcode data that indicates the meaning of the barcode data.
  • Maximum Length: 50
    Description of the data identifier.
  • Indicates the number of characters of the barcode data.
  • 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.
  • Maximum Length: 255
    Indicates if the number of characters of the barcode data is fixed or variable.
  • 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.
  • Maximum Length: 255
    Indicates the data type of the barcode data.
  • Maximum Length: 25
    Indicates the date format of the barcode data if the data type is date.
  • Maximum Length: 25
    Indicates the text that's used to specify the end of the data element.
  • 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.
  • Maximum Length: 255
    Indicates the field name to which barcode data should be mapped.
  • Maximum Length: 1
    Indicates if a GS1 group separator is used to specify the end of the data element.
  • Value that uniquely identifies the barcode format.
  • Maximum Length: 1
    Indicates if the last digit of the barcode data is a check digit.
  • Read Only: true
    Date when the user most recently updated the data identifier configuration.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the data identifier configuration.
  • Read Only: true
    Maximum Length: 32
    Login information of the user who most recently updated the data identifier configuration.
  • Read Only: true
    Value that uniquely identifies the data identifier configuration.
  • LinesDFF
  • Links
  • 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.
  • 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.
  • 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.
  • 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 : LinesDFF
Type: array
Show Source
Nested Schema : inventoryBarcodeFormats-dataIdentifierConfigurations-LinesDFF-item-response
Type: object
Show Source
Nested Schema : inventoryBarcodeFormats-HeadersDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to create one 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"

Example Request Body

The following example includes the contents of the request body in JSON format to create a barcode format with two data identifiers. 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 uses in the record that it creates.

{
    "BarcodeFormatName": "Custom Barcode Demo",
    "BarcodeFormatDescription": "Custom Barcode Demo",
    "BarcodeIdentifierPrefix": "$",
    "RetainPrefixFlag": false,
    "Status": "Y",
    "dataIdentifierConfigurations": [
        {
            "DataIdentifier": "L+",
            "DataIdentifierDescription": "Lot number",
            "FieldName": "Lot number",
            "DataLengthTypeName": "Variable",
            "DataLength": null,
            "GroupSeparatorFlag": false,
            "Delimiter": "|",
            "DataTypeName": "Text",
            "DateFormat": null,
            "IncludesCheckDigitFlag": false
        },
        {
            "DataIdentifier": "P+",
            "DataIdentifierDescription": "Item number",
            "FieldName": "Item",
            "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": 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-08T21:47:24.277+00:00",
    "LastUpdateLogin": "0F4AD200185DC6F8E063726515ACD8FA",
    "ObjectVersionNumber": 1,
    "dataIdentifierConfigurations": [
        {
            "HeaderId": 300100596176436,
            "LineId": 300100596176437,
            "DataIdentifier": "L+",
            "DataIdentifierDescription": "Lot number",
            "FieldCode": "ORA_LOT",
            "FieldName": "Lot number",
            "DataLengthType": "ORA_VARIABLE",
            "DataLengthTypeName": "Variable",
            "DataLength": null,
            "GroupSeparatorFlag": false,
            "Delimiter": "|",
            "DataType": "ORA_TEXT",
            "DataTypeName": "Text",
            "DateFormat": null,
            "IncludesCheckDigitFlag": false,
            "RetainDataIdentifierFlag": null,
            "MultiDataElementFlag": null,
            "DataElementSequenceNumber": null,
            "CreationDate": "2024-02-08T21:47:24.129+00:00",
            "CreatedBy": "SCMOPERATIONS",
            "LastUpdatedBy": "SCMOPERATIONS",
            "LastUpdateDate": "2024-02-08T21:47:24.289+00:00",
            "LastUpdateLogin": "0F4AD200185DC6F8E063726515ACD8FA",
            "ObjectVersionNumber": 1,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436/child/dataIdentifierConfigurations/300100596176437",
                    "name": "dataIdentifierConfigurations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436/child/dataIdentifierConfigurations/300100596176437",
                    "name": "dataIdentifierConfigurations",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436",
                    "name": "inventoryBarcodeFormats",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436/child/dataIdentifierConfigurations/300100596176437/child/LinesDFF",
                    "name": "LinesDFF",
                    "kind": "collection"
                }
            ]
        },
        {
            "HeaderId": 300100596176436,
            "LineId": 300100596176438,
            "DataIdentifier": "P+",
            "DataIdentifierDescription": "Item number",
            "FieldCode": "ORA_ITEM",
            "FieldName": "Item",
            "DataLengthType": "ORA_VARIABLE",
            "DataLengthTypeName": "Variable",
            "DataLength": null,
            "GroupSeparatorFlag": false,
            "Delimiter": "|",
            "DataType": "ORA_TEXT",
            "DataTypeName": "Text",
            "DateFormat": null,
            "IncludesCheckDigitFlag": false,
            "RetainDataIdentifierFlag": null,
            "MultiDataElementFlag": null,
            "DataElementSequenceNumber": null,
            "CreationDate": "2024-02-08T21:47:24.248+00:00",
            "CreatedBy": "SCMOPERATIONS",
            "LastUpdatedBy": "SCMOPERATIONS",
            "LastUpdateDate": "2024-02-08T21:47:24.301+00:00",
            "LastUpdateLogin": "0F4AD200185DC6F8E063726515ACD8FA",
            "ObjectVersionNumber": 1,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436/child/dataIdentifierConfigurations/300100596176438",
                    "name": "dataIdentifierConfigurations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436/child/dataIdentifierConfigurations/300100596176438",
                    "name": "dataIdentifierConfigurations",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436",
                    "name": "inventoryBarcodeFormats",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436/child/dataIdentifierConfigurations/300100596176438/child/LinesDFF",
                    "name": "LinesDFF",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100596176436",
            "name": "inventoryBarcodeFormats",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "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"
        }
    ]
}
Back to Top