Create RFID devices
post
/fscmRestApi/resources/11.13.18.05/inventoryRFIDDevices
Request
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.
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AssetItemId: integer
(int64)
Value that uniquely identifies the asset item.
-
ConfigurationId: integer
(int64)
Value that uniquely identifies the RFID configuration.
-
DeviceId: integer
(int64)
Value that uniquely identifies a device.
-
DeviceIdentifier: string
Maximum Length:
240
Device code from the manufacturer. -
DeviceName(required): string
Maximum Length:
120
Name associated with the device. -
DeviceTypeCode(required): string
Maximum Length:
30
Code associated with the device. -
EnabledFlag(required): boolean
Maximum Length:
1
Indicates if the device is enabled or not. -
LastConnectTime: string
(date-time)
Time stamp for the last successful connection to the device.
-
LocatorId: integer
(int64)
Value that uniquely identifies the locator.
-
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
processes: array
Processes
Title:
Processes
The processes associated with an RFID device. -
SubinventoryCode: string
Maximum Length:
10
Code that identifies the subinventory.
Nested Schema : Processes
Type:
array
Title:
Processes
The processes associated with an RFID device.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
DeviceId: integer
(int64)
Value that uniquely identifies a device.
-
DeviceProcessId: integer
(int64)
Value that uniquely identifies the device process.
-
EnabledFlag: boolean
Maximum Length:
1
Indicates if the process is enabled or not. -
EventTypeCode: string
Maximum Length:
30
Code that identifies the event type. -
ProcessParameters: string
(byte)
Process-specific parameters.
-
ProcessTypeCode: string
Maximum Length:
30
Code that identifies the process type. -
Sequence: integer
(int32)
Sequence of the process.
-
UnmapTagFlag: boolean
Maximum Length:
1
Indicates if the RFID tag should be unmapped after successful processing of this event.
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 : inventoryRFIDDevices-item-response
Type:
Show Source
object
-
AssetItemId: integer
(int64)
Value that uniquely identifies the asset item.
-
ConfigurationId: integer
(int64)
Value that uniquely identifies the RFID configuration.
-
ConfigurationName: string
Read Only:
true
Maximum Length:120
Name associated with the RFID configuration. -
DeviceId: integer
(int64)
Value that uniquely identifies a device.
-
DeviceIdentifier: string
Maximum Length:
240
Device code from the manufacturer. -
DeviceName: string
Maximum Length:
120
Name associated with the device. -
DeviceTypeCode: string
Maximum Length:
30
Code associated with the device. -
EnabledFlag: boolean
Maximum Length:
1
Indicates if the device is enabled or not. -
LastConnectTime: string
(date-time)
Time stamp for the last successful connection to the device.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocatorId: integer
(int64)
Value that uniquely identifies the locator.
-
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the organization. -
processes: array
Processes
Title:
Processes
The processes associated with an RFID device. -
SubinventoryCode: string
Maximum Length:
10
Code that identifies the subinventory.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Processes
Type:
array
Title:
Processes
The processes associated with an RFID device.
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 : inventoryRFIDDevices-processes-item-response
Type:
Show Source
object
-
DeviceId: integer
(int64)
Value that uniquely identifies a device.
-
DeviceProcessId: integer
(int64)
Value that uniquely identifies the device process.
-
EnabledFlag: boolean
Maximum Length:
1
Indicates if the process is enabled or not. -
EventTypeCode: string
Maximum Length:
30
Code that identifies the event type. -
EventTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Name for the event type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcessParameters: string
(byte)
Process-specific parameters.
-
ProcessTypeCode: string
Maximum Length:
30
Code that identifies the process type. -
ProcessTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Name for the process type. -
Sequence: integer
(int32)
Sequence of the process.
-
UnmapTagFlag: boolean
Maximum Length:
1
Indicates if the RFID tag should be unmapped after successful processing of this event.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- checkConnection
-
Operation: /fscmRestApi/resources/11.13.18.05/inventoryRFIDDevices/{DeviceId}/action/checkConnectionParameters:
- DeviceId:
$request.path.DeviceId
Checks if the device is connected. - DeviceId:
- processes
-
Parameters:
- DeviceId:
$request.path.DeviceId
The processes associated with an RFID device. - DeviceId: