Jump to

• Request
• Response

Update one RFDI device

patch

/fscmRestApi/resources/11.13.18.05/inventoryRFIDDevices/{DeviceId}

Request

Path Parameters

• DeviceId(required): integer(int64)
  Value that uniquely identifies a device.

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

• AssetItemId: integer (int64)
  Value that uniquely identifies the asset item.
• ConfigurationId: integer (int64)
  Value that uniquely identifies the RFID configuration.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "AssetItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ConfigurationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the RFID configuration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DeviceIdentifier":{
            "maxLength":240,
            "type":"string",
            "description":"Device code from the manufacturer.",
            "nullable":true
        },
        "DeviceName":{
            "maxLength":120,
            "type":"string",
            "description":"Name associated with the device.",
            "nullable":false
        },
        "DeviceTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code associated with the device.",
            "nullable":false
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the device is enabled or not.",
            "nullable":false
        },
        "LastConnectTime":{
            "type":"string",
            "description":"Time stamp for the last successful connection to the device.",
            "format":"date-time",
            "nullable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Code that identifies the subinventory.",
            "nullable":true
        },
        "processes":{
            "title":"Processes",
            "type":"array",
            "description":"The processes associated with an RFID device.",
            "items":{
                "$ref":"#/components/schemas/inventoryRFIDDevices-processes-item-patch-request"
            }
        }
    }
}

Nested Schema : Processes

Type: array

Title: Processes

The processes associated with an RFID device.

Show Source

• Array of: object schema

{
    "title":"Processes",
    "type":"array",
    "description":"The processes associated with an RFID device.",
    "items":{
        "$ref":"#/components/schemas/inventoryRFIDDevices-processes-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• DeviceId: integer (int64)
  Value that uniquely identifies a device.
• 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.

{
    "type":"object",
    "properties":{
        "DeviceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a device.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the process is enabled or not.",
            "nullable":false
        },
        "EventTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the event type.",
            "nullable":false
        },
        "ProcessParameters":{
            "type":"string",
            "description":"Process-specific parameters.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ProcessTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the process type.",
            "nullable":false
        },
        "Sequence":{
            "type":"integer",
            "description":"Sequence of the process.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            }
        },
        "UnmapTagFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the RFID tag should be unmapped after successful processing of this event.",
            "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 : inventoryRFIDDevices-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "AssetItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConfigurationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the RFID configuration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConfigurationName":{
            "maxLength":120,
            "type":"string",
            "description":"Name associated with the RFID configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeviceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a device.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DeviceIdentifier":{
            "maxLength":240,
            "type":"string",
            "description":"Device code from the manufacturer.",
            "nullable":true,
            "x-queryable":true
        },
        "DeviceName":{
            "maxLength":120,
            "type":"string",
            "description":"Name associated with the device.",
            "nullable":false,
            "x-queryable":true
        },
        "DeviceTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code associated with the device.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the device is enabled or not.",
            "nullable":false,
            "x-queryable":true
        },
        "LastConnectTime":{
            "type":"string",
            "description":"Time stamp for the last successful connection to the device.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the 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
        },
        "SubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Code that identifies the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "processes":{
            "title":"Processes",
            "type":"array",
            "description":"The processes associated with an RFID device.",
            "items":{
                "$ref":"#/components/schemas/inventoryRFIDDevices-processes-item-response"
            }
        }
    }
}

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

Type: array

Title: Processes

The processes associated with an RFID device.

Show Source

• Array of: object inventoryRFIDDevices-processes-item-response

{
    "title":"Processes",
    "type":"array",
    "description":"The processes associated with an RFID device.",
    "items":{
        "$ref":"#/components/schemas/inventoryRFIDDevices-processes-item-response"
    }
}

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."
        }
    }
}

Nested Schema : inventoryRFIDDevices-processes-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "DeviceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a device.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeviceProcessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the device process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the process is enabled or not.",
            "nullable":false,
            "x-queryable":true
        },
        "EventTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the event type.",
            "nullable":false,
            "x-queryable":true
        },
        "EventTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name for the event type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessParameters":{
            "type":"string",
            "description":"Process-specific parameters.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ProcessTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the process type.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name for the process type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Sequence":{
            "type":"integer",
            "description":"Sequence of the process.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "UnmapTagFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the RFID tag should be unmapped after successful processing of this event.",
            "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"
    }
}

Links

checkConnection

Operation: /fscmRestApi/resources/11.13.18.05/inventoryRFIDDevices/{DeviceId}/action/checkConnection

Parameters:

• DeviceId: $request.path.DeviceId

Checks if the device is connected.

processes

Operation: /fscmRestApi/resources/11.13.18.05/inventoryRFIDDevices/{DeviceId}/child/processes

Parameters:

• DeviceId: $request.path.DeviceId

The processes associated with an RFID device.

Back to Top