Update Workstation Devices
post
/config/sim/v1/devices/workstations/updateDevices
Updates a Workstation Device record for the current organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef(optional): string(string)
Detail that identifies who made the change.
-
Simphony-OrgShortName: string(string)
Org Identifier
Workstation Device Object
Root Schema : WorkstationDevice
Type:
Show Source
object-
baudRate(optional):
integer
Baud Rate of the device. Allowed values - 1200, 2400, 4800, 9600, 19200,38400Example:
9600 -
clientCertCommonName(optional):
string
Client certificate common name of the payment interfaceExample:
Certificate -
clientCertEffectiveDt(optional):
string
Client Certificate effective date of the payment interfaceExample:
2020-10-11 -
clientCertExpDt(optional):
string
Expiration date of the client certificate of the payment interfaceExample:
2020-10-11 -
clientCertificate(optional):
string
Client Certificate object. Applicable only for type=20 and SPIExample:
Cert -
clientCertPassword(optional):
string
Client Certificate passwordExample:
password -
comPort(optional):
integer
COM Port of the deviceExample:
1 -
configuration(optional):
string
Configuration parameters of the custom peripheral deviceExample:
config -
customDevice(optional):
integer
Device type of the custom peripheral deviceExample:
1 -
customDeviceSettingsConfig(optional):
string
Configuration parameters of the peripheral deviceExample:
Custom Settings -
dataBits(optional):
integer
Data bits of the deviceExample:
1 -
deleteCertificate(optional):
boolean
A flag indicating if the certificates need to be deleted. Applicable for type=20 and for SPI only.Example:
false -
deviceNum:
integer
Sequence number of the deviceExample:
1 -
deviceType(optional):
integer
Type of the peripheral deviceExample:
1 -
hierUnitId:
integer
Unique hierarchy unit value of the propertyExample:
1 -
hierUnitName(optional):
object HierUnitNameTranslatedString
A string that contains translations of hierarchy unit name into multiple languages
-
hierUnitObjNum(optional):
integer
Object number of the propertyExample:
1 -
hostTimeoutInSecs(optional):
integer
Timeout in seconds if request is abandonedExample:
180 -
name:
object HierUnitNameTranslatedString
A string that contains translations of hierarchy unit name into multiple languages
-
objectNum:
integer
Object number of the workstationExample:
1 -
parity(optional):
string
Parity of the deviceExample:
N -
primaryHost(optional):
string
URL of the endpoint. Format http(s)://host:port numberExample:
http://url.domain.com:443 -
progId(optional):
string
Prog Id of the custom peripheral deviceExample:
Micros.Devices.BarCodeReader.RS232 -
securitySettings(optional):
integer
Security settings for the interfaceExample:
1 -
serverCertCommonName(optional):
string
Common name of the Server CertificateExample:
cert -
serverCertEffectiveDt(optional):
string
Effective date of the server certificateExample:
2020-10-11 -
serverCertExpDt(optional):
string
Effective date of the server certificateExample:
2020-10-11 -
serverCertificate(optional):
string
Server certificate objectExample:
cert -
stopBits(optional):
integer
Stop Bits of the deviceExample:
1 -
validateXMLAgainstSchema(optional):
boolean
A Boolean flag indicating if xml message is validated against schema and log errors. Applicable only for type=20 and SPI.Example:
false
Nested Schema : HierUnitNameTranslatedString
Type:
objectA string that contains translations of hierarchy unit name into multiple languages
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"ar-AR":"??????????"
}Response
Supported Media Types
- application/json
200 Response
A collection of WorkstationDevice objects of the organization
Root Schema : WorkstationDeviceResponse
Type:
Show Source
object-
deviceNum:
integer
The sequence number of the deviceExample:
1 -
hierUnitId:
integer
Unique hierarchy unit value of the propertyExample:
1 -
objectNum:
integer
Object number of the workstationExample:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(optional):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(optional):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(optional):
integer
Error code of the problemExample:
55223 -
status(optional):
integer
HTTP status code.Example:
400 -
title(optional):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(optional):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html