Used to create a device.
POST
/api/v1/{tenantId}/devices
Plugin API access: this operation accepts a plugin JWT (PluginBearer) for its own tenant.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” tenantId
required
string
Request Body
Section titled “Request Body ”object
libraryElementDeviceId
string
name
string
description
string
jsonModelId
string
Responses
Section titled “ Responses ”OK
object
device
object
tenantId
string
tenantUuid
string
assemblyName
string
assemblyFullPath
string
typeName
string
version
string
deviceName
string
deviceDescription
string
deviceInstanceId
string
deviceDescriptorId
string
revoWebDeviceInfo
object
name
string
description
string
groupNames
Array<string>
isAvailable
boolean
isUnitTestOnly
boolean
allowedOrganisations
Array<string>
allowedTenants
Array<string>
supportedModels
Array<string>
properties
Array<object>
object
propertyName
string
propertyDescriptor
string
description
string
primitiveType
string
parameterType
string
isEnabled
boolean
currentValue
string
parameterNameValue
string
min
number format: double
max
number format: double
defaultValue
string
placeHolder
string
visiblityRequirement
object
propertyName
string
matchValues
Array<string>
isInverse
boolean
precision
number format: float
currentUnit
integer format: int32
unitOptions
Array<integer>
textType
string
regexError
string
regexErrorMsg
string
valueOptions
Array<string>
targetValueOptions
Array<string>
allowCustomValueOptions
boolean
isMultiSelect
boolean
isObjectPairMapping
boolean
isEnum
boolean
operations
Array<object>
object
name
string
description
string
parameters
Array<object>
object
propertyName
string
propertyDescriptor
string
description
string
primitiveType
string
parameterType
string
isEnabled
boolean
currentValue
string
parameterNameValue
string
min
number format: double
max
number format: double
defaultValue
string
placeHolder
string
visiblityRequirement
object
propertyName
string
matchValues
Array<string>
isInverse
boolean
precision
number format: float
currentUnit
integer format: int32
unitOptions
Array<integer>
textType
string
regexError
string
regexErrorMsg
string
valueOptions
Array<string>
targetValueOptions
Array<string>
allowCustomValueOptions
boolean
isMultiSelect
boolean
isObjectPairMapping
boolean
isEnum
boolean
locations
Array<object>
object
tenantId
string
tenantUuid
string
name
string
locationId
string
attachToPartId
string
position
Array<number>
orientation
Array<number>
isEnabled
boolean
isHidden
boolean
isTeachDisabled
boolean
claimParentDevice
boolean
simulatorPosition
Array<number>
deviceType
integer format: int32
robotConfig
object
locationPaths
Array<object>
object
locationId
string
locationName
string
waypoints
Array<object>
object
position
object
x
number format: double
y
number format: double
z
number format: double
orientation
object
x
number format: double
y
number format: double
z
number format: double
joints
Array<number>
parameters
object
isSafeApproachPosition
boolean
speedPercent
number format: double
railPosition
number format: double
parameters
object
gripOrientation
integer format: int32
gripProfile
integer format: int32
regripBeforePlace
boolean
isRegripLocation
boolean
gripperOpenClearance
number format: double
robotType
string
isTeachModeActive
boolean
gripperMovementMode
string
reachableLocations
Array<object>
object
locationId
string
locationName
string
defaultGripperOpenClearance
number format: double
Bad Request
object
message
string
code
string
Too Many Requests
object
message
string
code
string