Jump to

• Request
• Response

Upsert Workstation Classes

post

/config/sim/v2/devices/upsertWorkstationClasses

Updates provided fields if the Workstation Class exists; inserts a new Workstation Class if it doesn't

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

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

Body ()

A request body

Root Schema : schema

Type: object

Show Source

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

  Example: 1
• name: object name
  Workstation Class Name. Required to create a new Workstation Class.
• objectNum(required): integer
  Object Number of the workstation class

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique hierarchy unit value. The hierUnitId should be only of a location or the enterprise.",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object Number of the workstation class",
            "type":"integer",
            "example":1
        },
        "name":{
            "description":"Workstation Class Name. Required to create a new Workstation Class.",
            "type":"object",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        }
    }
}

Nested Schema : name

Type: object

Workstation Class Name. Required to create a new Workstation Class.

Example:

{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Workstation class Updated.

Body ()

Root Schema : schema

Type: object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• objectNum: integer
  Object number of the Workstation class

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "description":"Unique hierarchy unit value",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the Workstation class",
            "type":"integer",
            "example":1
        }
    }
}

201 Response

Workstation Class Inserted.

Body ()

Root Schema : schema

Type: object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value of the property

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

  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 CLass",
            "type":"integer",
            "example":1
        }
    }
}

Back to Top