Jump to

• Request
• Response

Upsert SPI Client Certificate

post

/content/sim/v2/devices/workstations/upsertSpiClientCertificate

Updates the client certificate for the given SPI device if it exists, else inserts a client certificate.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

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

Body ()

Upsert Request body

Root Schema : schema

Type: object

Show Source

• deviceNum(required): integer
  Sequence number of the device

  Example: 1
• hierUnitId(required): integer
  Unique hierarchy unit value

  Example: 2
• objectNum(required): integer
  Object number of the workstation

  Example: 1
• passKey(required): string
  The password for the client certificate file.

  Example: pass@123

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "deviceNum",
        "passKey"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit value"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the workstation"
        },
        "deviceNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the device"
        },
        "passKey":{
            "type":"string",
            "example":"pass@123",
            "description":"The password for the client certificate file."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

SPI Client Certificate Updated.

Body ()

Root Schema : schema

Type: object

Show Source

• deviceNum: integer
  Sequence number of the device

  Example: 1
• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• objectNum: integer
  Object Number of the workstation

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the workstation"
        },
        "deviceNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the device"
        }
    }
}

201 Response

SPI Client Certificate Added.

Body ()

Root Schema : schema

Type: object

Show Source

• deviceNum: integer
  Sequence number of the device

  Example: 1
• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• objectNum: integer
  Object Number of the workstation

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the workstation"
        },
        "deviceNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the device"
        }
    }
}

Back to Top