Jump to

• Request
• Response

Upsert Workstation Devices

post

/config/sim/v2/devices/workstations/upsertDevices

Updates provided fields if the workstation device exists else inserts a new device.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.

Body ()

Workstation Device Upsert request body

Root Schema : schema

Type: object

Show Source

• baudRate: integer
  Baud Rate of the device. Allowed values - 1200, 2400, 4800, 9600, 19200, 38400. Value cannot be null for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.

  Example: 9600
• comPort: integer
  COM Port of the device. Value cannot be null for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.

  Example: 1
• customDevice: integer
  Device type of the custom peripheral device. If non-null, resets the value of deviceType field.

  Example: 1
• dataBits: integer
  Data bits of the device. Value cannot be null for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.

  Example: 1
• deviceNum(required): integer
  Sequence number of the device

  Example: 1
• deviceType: integer
  Type of the peripheral device. Required to create a new device.

  Example: 1
• hierUnitId(required): integer
  Unique hierarchy unit value of the property

  Example: 1
• hostTimeoutInSecs: integer
  Timeout in seconds if request is abandoned. Value cannot be null for device type 20.

  Example: 180
• objectNum(required): integer
  Object number of the workstation

  Example: 1
• parity: string
  Parity of the device. Value cannot be null for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.

  Example: N
• primaryHost: string
  URL of the endpoint. Format http(s)://host:port number. Value cannot be null for device type 20.

  Example: http://url.domain.com:443
• progId: string
  Prog Id of the custom peripheral device. Required to create a new device.

  Example: Micros.Devices.BarCodeReader.RS232
• securitySettings: integer
  Security settings for the interface. Value cannot be null for device type 20.

  Example: 1
• stopBits: integer
  Stop Bits of the device. Value cannot be null for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.

  Example: 1
• validateXMLAgainstSchema: boolean
  A Boolean flag indicating if xml message is validated against schema and log errors. Applicable only for type=20 and SPI.

  Example: false

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "deviceNum"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique hierarchy unit value of the property",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the workstation",
            "type":"integer",
            "example":1
        },
        "deviceNum":{
            "description":"Sequence number of the device",
            "type":"integer",
            "example":1
        },
        "deviceType":{
            "description":"Type of the peripheral device. Required to create a new device.",
            "type":"integer",
            "example":1
        },
        "comPort":{
            "description":"COM Port of the device. Value cannot be null for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.",
            "type":"integer",
            "example":1
        },
        "baudRate":{
            "description":"Baud Rate of the device. Allowed values - 1200, 2400, 4800, 9600, 19200, 38400. Value cannot be null for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.",
            "type":"integer",
            "example":9600
        },
        "parity":{
            "description":"Parity of the device. Value cannot be null for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.",
            "type":"string",
            "example":"N"
        },
        "dataBits":{
            "description":"Data bits of the device. Value cannot be null for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.",
            "type":"integer",
            "example":1
        },
        "stopBits":{
            "description":"Stop Bits of the device. Value cannot be null for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.",
            "type":"integer",
            "example":1
        },
        "customDevice":{
            "description":"Device type of the custom peripheral device. If non-null, resets the value of deviceType field.",
            "type":"integer",
            "example":1
        },
        "progId":{
            "description":"Prog Id of the custom peripheral device. Required to create a new device.",
            "type":"string",
            "example":"Micros.Devices.BarCodeReader.RS232"
        },
        "hostTimeoutInSecs":{
            "description":"Timeout in seconds if request is abandoned. Value cannot be null for device type 20.",
            "type":"integer",
            "example":180
        },
        "primaryHost":{
            "description":"URL of the endpoint. Format http(s)://host:port number. Value cannot be null for device type 20.",
            "type":"string",
            "example":"http://url.domain.com:443"
        },
        "securitySettings":{
            "description":"Security settings for the interface. Value cannot be null for device type 20.",
            "type":"integer",
            "example":1
        },
        "validateXMLAgainstSchema":{
            "description":"A Boolean flag indicating if xml message is validated against schema and log errors. Applicable only for type=20 and SPI.",
            "type":"boolean",
            "example":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Update operation executed successfully.

Body ()

Root Schema : schema

Type: object

Show Source

• deviceNum: integer
  The sequence number of the device

  Example: 1
• hierUnitId: integer
  Unique hierarchy unit value of the property

  Example: 1
• objectNum: integer
  Object number of the workstation

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique hierarchy unit value of the property",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the workstation",
            "type":"integer",
            "example":1
        },
        "deviceNum":{
            "description":"The sequence number of the device",
            "type":"integer",
            "example":1
        }
    }
}

201 Response

Insert operation executed successfully.

Body ()

Root Schema : schema

Type: object

Show Source

• deviceNum: integer
  The sequence number of the device

  Example: 1
• hierUnitId: integer
  Unique hierarchy unit value of the property

  Example: 1
• objectNum: integer
  Object number of the workstation

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique hierarchy unit value of the property",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the workstation",
            "type":"integer",
            "example":1
        },
        "deviceNum":{
            "description":"The sequence number of the device",
            "type":"integer",
            "example":1
        }
    }
}

Back to Top