Get Workstation Classes
post
/config/sim/v2/devices/getWorkstationClasses
Gets all the Workstation Class configured
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : WorkstationClassGetRequestBodyv2
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
Objects included in response
-
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
langIds:
string
If specified, limits translated strings returned.Example:
1,2,3 -
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
2 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of workstation class objects of the organization
Root Schema : WorkstationClassGetResponsev2
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Workstation Class objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Workstation Class objects of the organization.
Show Source
Nested Schema : WorkstationClassv2
Type:
Show Source
object-
hierUnitId:
integer
Unique hierarchy unit value. The hierUnitId should be only of a location or the enterprise.Example:
1 -
hierUnitObjNum:
integer
Hierarchy unit object numberExample:
1 -
name:
object name
Workstation Class Name
-
objectNum:
integer
Object Number of the workstation classExample:
1
Nested Schema : name
Type:
objectWorkstation Class Name
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
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