Jump to

• Request
• Response

Upsert Print Classes

post

/config/sim/v2/devices/upsertPrinterClasses

Updates provided fields if the Print Class object exists, else inserts a new Print Class.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

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

Body ()

Print Class Upsert Request Body

Root Schema : schema

Type: object

Model for Print Class Upsert Request

Show Source

• hierUnitId(required): integer
  Unique reference of the hierarchy unit where the print class is configured

  Example: 3599
• name: object name
  Name of the Print Class. Required field to create a new Print Class.
• objectNum(required): integer
  Object Number of the Print Class.

  Example: 1
• options: string
  A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the Print Class

  Example: 11010101
• orderDeviceDisabled: string
  A string value of 0s & 1s of length 32 representing the enablement or disablement of the order devices associated with the Print Class

  Example: 11010101110101011101010111010101
• orderDeviceOutput: string
  A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device output associated with the Print Class. It is set to all 0's if routingGroupObjNum has a non NULL value.

  Example: 11010101110101011101010111010101
• routingGroupObjNum: integer
  Select the routing group to use for each print class if Routing Group Printing is enabled.

  Example: 3

{
    "description":"Model for Print Class Upsert Request",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the print class is configured",
            "type":"integer",
            "example":3599
        },
        "objectNum":{
            "description":"Object Number of the Print Class.",
            "type":"integer",
            "example":1
        },
        "name":{
            "type":"object",
            "description":"Name of the Print Class. Required field to create a new Print Class.",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "options":{
            "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the Print Class",
            "type":"string",
            "example":"11010101"
        },
        "routingGroupObjNum":{
            "description":"Select the routing group to use for each print class if Routing Group Printing is enabled.",
            "type":"integer",
            "example":3
        },
        "orderDeviceOutput":{
            "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device output associated with the Print Class. It is set to all 0's if routingGroupObjNum has a non NULL value.",
            "type":"string",
            "example":"11010101110101011101010111010101"
        },
        "orderDeviceDisabled":{
            "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order devices associated with the Print Class",
            "type":"string",
            "example":"11010101110101011101010111010101"
        }
    }
}

Nested Schema : name

Type: object

Name of the Print Class. Required field to create a new Print Class.

Example:

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Print Class Updated.

Body ()

Root Schema : schema

Type: object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• objectNum: integer
  Object number of the printer

  Example: 1

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

201 Response

Print Class Added.

Body ()

Root Schema : schema

Type: object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• objectNum: integer
  Object number of the printer

  Example: 1

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

Back to Top