Jump to

• Request
• Response

Get Workstation Classes

post

/config/sim/v1/devices/getWorkstationClasses

Gets all the Workstation Class configured

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

A request body

Root Schema : WorkstationClassGetRequestBody

Type: object

The 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
• languages: string
  If specified, limits translated strings returned.
• 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)

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "example":2,
            "description":"Starting resource record index. Not required if paging parameters are not supported."
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Number of results returned in this page. Not required if paging parameters are not supported."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(active,1)",
            "description":"Search criteria to filter results based on field value."
        },
        "include":{
            "type":"string",
            "description":"Objects included in response"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n"
        },
        "languages":{
            "type":"string",
            "description":"If specified, limits translated strings returned."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of workstation class objects of the organization

Body ()

Root Schema : WorkstationClass

Type: object

Show Source

• hierUnitId(required): integer
  Unique hierarchy unit value. The hierUnitId should be only of a location or the enterprise.

  Example: 1
• hierUnitName(required): object HierUnitNameTranslatedString
  A string that contains translations of hierarchy unit name into multiple languages
• hierUnitObjNum(required): integer
  Hierarchy unit object number

  Example: 1
• name(required): object HierUnitNameTranslatedString
  A string that contains translations of hierarchy unit name into multiple languages
• objectNum(required): integer
  Object Number of the workstation class

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "hierUnitObjNum",
        "hierUnitName",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique hierarchy unit value. The hierUnitId should be only of a location or the enterprise.",
            "type":"integer",
            "example":1
        },
        "hierUnitObjNum":{
            "description":"Hierarchy unit object number",
            "type":"integer",
            "example":1
        },
        "hierUnitName":{
            "$ref":"#/definitions/HierUnitNameTranslatedString"
        },
        "objectNum":{
            "description":"Object Number of the workstation class",
            "type":"integer",
            "example":1
        },
        "name":{
            "$ref":"#/definitions/HierUnitNameTranslatedString"
        }
    }
}

Nested Schema : HierUnitNameTranslatedString

Type: object

A string that contains translations of hierarchy unit name into multiple languages

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "es-MX":"Propiedad"
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response 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 problem

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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top