Update one RFID event
patch
/fscmRestApi/resources/11.13.18.05/inventoryRFIDEvents/{EventActionId}
Request
Path Parameters
-
EventActionId(required): integer(int64)
Value that uniquely identifies an event action.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActionTypeCode: string
Maximum Length:
30
Event action type code. -
ErrorMessage: string
Maximum Length:
4000
Processing-error message. -
EventId: integer
(int64)
Value that uniquely identifies an event.
-
EventKey: string
Maximum Length:
240
Unique identifier for each event. -
EventTime: string
(date-time)
Timestamp of the event.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies an item.
-
OrganizationId: integer
(int64)
Value that uniquely identifies an organization.
-
ProcessResponse: string
(byte)
Response of the inventory transaction.
-
ProcessStatusCode: string
Maximum Length:
30
Status of the process. -
ProcessTypeCode: string
Maximum Length:
30
Code of the process to be spawned when an event occurs. -
TagCode: string
Maximum Length:
64
RFID tag.
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 : inventoryRFIDEvents-item-response
Type:
Show Source
object
-
ActionTypeCode: string
Maximum Length:
30
Event action type code. -
ActionTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Event action type name. -
DeviceId: integer
(int64)
Read Only:
true
Value that uniquely identifies a device. -
DeviceIdentifier: string
Read Only:
true
Maximum Length:240
Value that uniquely identify the device. -
DeviceName: string
Read Only:
true
Maximum Length:120
Name of the device. -
ErrorMessage: string
Maximum Length:
4000
Processing-error message. -
EventActionId: integer
(int64)
Value that uniquely identifies an event action.
-
EventDatetime: string
(date-time)
Read Only:
true
Identifies the date and time when the event was generated. -
EventErrorMessage: string
Read Only:
true
Maximum Length:4000
Event-processing error messages. -
EventId: integer
(int64)
Value that uniquely identifies an event.
-
EventKey: string
Maximum Length:
240
Unique identifier for each event. -
EventPayload: string
(byte)
Read Only:
true
Identifies the content of the event. -
EventTime: string
(date-time)
Timestamp of the event.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies an item.
-
ItemNumber: string
Read Only:
true
Maximum Length:300
Item number. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Value that uniquely identifies an organization.
-
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the organization. -
ProcessingStatus: string
Read Only:
true
Maximum Length:30
Status of processing for this event. -
ProcessResponse: string
(byte)
Response of the inventory transaction.
-
ProcessStatusCode: string
Maximum Length:
30
Status of the process. -
ProcessTypeCode: string
Maximum Length:
30
Code of the process to be spawned when an event occurs. -
ProcessTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Name of the process type. -
RequestIdentifier: integer
(int64)
Read Only:
true
Request Identifier. -
TagCode: string
Maximum Length:
64
RFID tag.
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.