Get all inventory barcode formats
get
/fscmRestApi/resources/11.13.18.05/inventoryBarcodeFormats
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds the barcode format with the specified primary key.
Finder Variables- HeaderId; integer; Unique identifier of the barcode format.
- PrimaryKey Finds the barcode format with the specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- BarcodeFormatDescription; string; Description of the barcode format.
- BarcodeFormatName; string; Name of the barcode format.
- BarcodeIdentifierPrefix; string; Prefix of the barcode that will be used to identify the barcode format.
- CreatedBy; string; User who created the barcode format.
- CreationDate; string; Date when the user created the barcode format.
- HeaderId; integer; Value that uniquely identifies the barcode format.
- IncludesCheckDigitFlag; boolean; 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 when the user most recently updated the barcode format.
- LastUpdateLogin; string; Login information of the user who most recently updated the barcode format.
- LastUpdatedBy; string; User who most recently updated the barcode format.
- ObjectVersionNumber; integer; 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; Indicates if the prefix of the barcode should be retained or removed before parsing the barcode data.
- Status; string; Status of the barcode format.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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
Examples
This example describes how to get all inventory barcode formats.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "items": [ { "HeaderId": 300100583421613, "BarcodeFormatName": "GS1-128", "BarcodeFormatDescription": "GS1-128 Barcode format", "BarcodeIdentifierPrefix": "]C1", "RetainPrefixFlag": false, "Status": "Y", "CreationDate": "2023-12-23T19:08:35+00:00", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "LastUpdateDate": "2023-12-23T19:08:44.939+00:00", "LastUpdateLogin": "-1", "ObjectVersionNumber": 1, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100583421613", "name": "inventoryBarcodeFormats", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100583421613", "name": "inventoryBarcodeFormats", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100583421613/child/HeadersDFF", "name": "HeadersDFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100583421613/child/dataIdentifierConfigurations", "name": "dataIdentifierConfigurations", "kind": "collection" } ] }, { "HeaderId": 300100592737247, "BarcodeFormatName": "TBC01110210", "BarcodeFormatDescription": "Item data identifier", "BarcodeIdentifierPrefix": "01110210", "RetainPrefixFlag": false, "Status": "Y", "CreationDate": "2024-02-01T12:00:10+00:00", "CreatedBy": "WHSE_MGR_M1", "LastUpdatedBy": "WHSE_MGR_M1", "LastUpdateDate": "2024-02-01T12:00:10.147+00:00", "LastUpdateLogin": "0F48B9E59F23C8FDE063746415ACDD32", "ObjectVersionNumber": 1, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100592737247", "name": "inventoryBarcodeFormats", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100592737247", "name": "inventoryBarcodeFormats", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100592737247/child/HeadersDFF", "name": "HeadersDFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats/300100592737247/child/dataIdentifierConfigurations", "name": "dataIdentifierConfigurations", "kind": "collection" } ] }, { "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, "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" } ] } ], "count": 3, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryBarcodeFormats", "name": "inventoryBarcodeFormats", "kind": "collection" } ] }