Get one tag
get
/fscmRestApi/resources/11.13.18.05/physicalInventoryTags/{TagId}
Request
Path Parameters
-
TagId(required): integer(int64)
Value that uniquely identifies the physical inventory tag.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : physicalInventoryTags-item-response
Type:
Show Source
object
-
AdjustmentId: integer
(int64)
Title:
Adjustment
Read Only:true
Value that uniquely identifies the physical inventory adjustment. -
CountedByEmployeeId: integer
(int64)
Title:
Counted By
Value that uniquely identifies the person who performed the physical count. -
CountedByEmployeeName: string
Maximum Length:
255
Name of the user who performed the physical inventory count. -
inventoryAttributesDFF: array
Flexfields for Tracking Attributes
Title:
Flexfields for Tracking Attributes
The Flexfields for Tracking Attributes resource manages details of the descriptive flexfields that reference the physical inventory tags. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item number in physical inventory.
-
ItemNumber: string
Maximum Length:
255
Name of the item. This item is unique compared to other items according to item attributes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Maximum Length:
255
Physical area, such as a row, aisle, bin, or shelf, in the subinventory that stores material. -
LocatorId: integer
(int64)
Title:
Locator
Value that uniquely identifies the locator. -
LotExpirationDate: string
(date-time)
Title:
Lot Expiration Date
Date when the availability of the lot for transaction and planning purposes expires. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies the lot. Inventory uses the lot to create items that share the similar production costs and specifications. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
OwningEntityId: integer
(int64)
Value that uniquely identifies the owning party that is financially responsible for consigned inventory.
-
OwningParty: string
Maximum Length:
255
Owning party that is financially responsible for consigned inventory. -
OwningPartySite: string
Maximum Length:
255
Value that identifies the party site where the owning party resides. -
OwningType: string
Maximum Length:
255
Type of owner of the financial liability of consigned inventory. Contains one of the following values. Supplier site: owning party is supplier site Inventory organization: owning party is inventory organization. The default value is Inventory organization. -
OwningTypeCode: string
Maximum Length:
30
Default Value:2
Abbreviation that identifies the type of owner of the financial liability of consigned inventory. Contains one of the following values. 1: owning party is supplier site 2: owning party is inventory organization. The default value is 2. -
PhysicalInventoryId: integer
(int64)
Title:
Physical Inventory
Value that uniquely identifies the physical inventory. -
PhysicalInventoryName: string
Maximum Length:
255
Name of the physical inventory. -
physicalInventoryTagDFFs: array
Flexfields for Physical Inventory Tags
Title:
Flexfields for Physical Inventory Tags
The Flexfields for Physical Inventory Tags resource manages descriptive flexfields that store details about physical inventory tags. -
ProcurementBU: string
Maximum Length:
255
Business unit that manages and owns the purchasing document. -
Revision: string
Maximum Length:
18
Version of the item that inventory is counting. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Number that uniquely identifies a single quantity of the item inventory is counting. -
Subinventory: string
Maximum Length:
10
Physical or logical area in the inventory organization where you store material. -
TagId: integer
(int64)
Value that uniquely identifies the physical inventory tag.
-
TagNumber: string
Title:
Tag
Maximum Length:40
Number that inventory assigns to the physical inventory tag. It represents the contents of a unique item location in inventory. -
TagQuantity: number
Title:
Count Quantity
Quantity of the stock keeping unit on the tag for the item. -
TagSecondaryQuantity: number
Title:
Secondary Quantity
Quantity in the secondary unit of measure of the item. -
TagSecondaryUnitOfMeasure: string
Maximum Length:
255
Secondary unit of measure of the item. -
TagSecondaryUOMCode: string
Title:
Secondary UOM
Maximum Length:3
Abbreviation that identifies the secondary unit of measure of the item. -
TagType: string
Maximum Length:
255
Type of physical inventory tags generated after the generate tags action. A list of accepted values is defined in the lookup type INV_TAG_TYPE. There is no default value for this attribute. -
TagTypeCode: string
Title:
Tag Type
Maximum Length:30
Abbreviation that identifies the type of physical inventory tag that the create tag action creates. -
TagUnitOfMeasure: string
Maximum Length:
255
Unit of measure of the quantity for the stock keeping unit counted on the tag. -
TagUOMCode: string
Title:
Count UOM
Maximum Length:3
Abbreviation that identifies the unit of measure of the quantity for the stock keeping unit counted on the tag. -
TagVoid: string
Maximum Length:
255
Value that indicates if the tag is not valid. Contains one of the following values. Void: tag is void. Active: tag is active. The default value is Active. -
TagVoidCode: string
Title:
Void
Maximum Length:30
Default Value:2
Value that indicates if the tag is not valid. Contains one of the following values. 1: tag is void. 2: tag is active. The default value is 2.
Nested Schema : Flexfields for Tracking Attributes
Type:
array
Title:
Flexfields for Tracking Attributes
The Flexfields for Tracking Attributes resource manages details of the descriptive flexfields that reference the physical inventory tags.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Physical Inventory Tags
Type:
array
Title:
Flexfields for Physical Inventory Tags
The Flexfields for Physical Inventory Tags resource manages descriptive flexfields that store details about physical inventory tags.
Show Source
Nested Schema : physicalInventoryTags-inventoryAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive flexfield context name for tracking attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for tracking attributes. -
countryOfOriginCode: string
Title:
Country of Origin
Maximum Length:2
Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country of origin. This attribute is associated with a feature that requires opt in. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
Project
Number that identifies the project. This attribute is associated with a feature that requires opt in. -
TagId: integer
(int64)
Value that uniquely identifies the physical inventory tag.
-
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
Task
Number that identifies the task. This attribute is associated with a feature that requires opt in.
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 : physicalInventoryTags-physicalInventoryTagDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
Descriptive flexfield context name for physical inventory tags. -
__FLEX_Context_DisplayValue: string
Title:
Context
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TagId: integer
(int64)
Value that uniquely identifies the physical inventory tag.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- inventoryAttributesDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/physicalInventoryTags/{TagId}/child/inventoryAttributesDFFParameters:
- TagId:
$request.path.TagId
The Flexfields for Tracking Attributes resource manages details of the descriptive flexfields that reference the physical inventory tags. - TagId:
- physicalInventoryTagDFFs
-
Operation: /fscmRestApi/resources/11.13.18.05/physicalInventoryTags/{TagId}/child/physicalInventoryTagDFFsParameters:
- TagId:
$request.path.TagId
The Flexfields for Physical Inventory Tags resource manages descriptive flexfields that store details about physical inventory tags. - TagId: