Jump to

• Request
• Response

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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• LPNId: integer (int64)
  Value that uniquely identifies the LPN.
• 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.

{
    "type":"object",
    "properties":{
        "ActionTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Event action type code.",
            "nullable":false
        },
        "ErrorMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Processing-error message.",
            "nullable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Value that uniquely identifies an event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EventKey":{
            "maxLength":240,
            "type":"string",
            "description":"Unique identifier for each event.",
            "nullable":true
        },
        "EventTime":{
            "type":"string",
            "description":"Timestamp of the event.",
            "format":"date-time",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies an item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LPNId":{
            "type":"integer",
            "description":"Value that uniquely identifies the LPN.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies an organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProcessResponse":{
            "type":"string",
            "description":"Response of the inventory transaction.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ProcessStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the process.",
            "nullable":false
        },
        "ProcessTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the process to be spawned when an event occurs.",
            "nullable":false
        },
        "TagCode":{
            "maxLength":64,
            "type":"string",
            "description":"RFID tag.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : inventoryRFIDEvents-item-response

Type: object

Show Source

• 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.
• LicensePlateNumber: string
  Title: Packing Unit

  Read Only: true

  Maximum Length: 30

  Name of the LPN.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LPNId: integer (int64)
  Value that uniquely identifies the LPN.
• ObjectTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Uniquely identifies the type of object to which the given EPC code is mapped.
• 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.

{
    "type":"object",
    "properties":{
        "ActionTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Event action type code.",
            "nullable":false,
            "x-queryable":true
        },
        "ActionTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Event action type name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeviceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a device.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeviceIdentifier":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identify the device.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeviceName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the device.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Processing-error message.",
            "nullable":true,
            "x-queryable":true
        },
        "EventActionId":{
            "type":"integer",
            "description":"Value that uniquely identifies an event action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EventDatetime":{
            "type":"string",
            "description":"Identifies the date and time when the event was generated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventErrorMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Event-processing error messages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Value that uniquely identifies an event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventKey":{
            "maxLength":240,
            "type":"string",
            "description":"Unique identifier for each event.",
            "nullable":true,
            "x-queryable":true
        },
        "EventPayload":{
            "type":"string",
            "description":"Identifies the content of the event.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EventTime":{
            "type":"string",
            "description":"Timestamp of the event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies an item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Item number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LPNId":{
            "type":"integer",
            "description":"Value that uniquely identifies the LPN.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LicensePlateNumber":{
            "title":"Packing Unit",
            "maxLength":30,
            "type":"string",
            "description":"Name of the LPN.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Uniquely identifies the type of object to which the given EPC code is mapped.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies an organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessResponse":{
            "type":"string",
            "description":"Response of the inventory transaction.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ProcessStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the process.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the process to be spawned when an event occurs.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name of the process type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status of processing for this event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestIdentifier":{
            "type":"integer",
            "description":"Request Identifier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TagCode":{
            "maxLength":64,
            "type":"string",
            "description":"RFID tag.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top