Jump to

• Request
• Response

Update SPI server certificate

post

/content/sim/v1/devices/workstations/updateSPIserverCertificate

Updates the SPI server certificate for the given workstation device. If certificate is not found, it adds a new SPI server certificate to the workstation device.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

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

Body ()

Request body

Root Schema : SPIServerCertificateCURequestBody

Type: object

Show Source

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

  Example: 1
• fileName(required): string
  The name of the server certificate file with extension.

  Example: ServerCertificate.xml
• hierUnitId(required): integer
  Unique hierarchy unit value

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

  Example: 1
• size: integer
  The size of the certificate file in bytes.

  Example: 72534

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "deviceNum",
        "fileName"
    ],
    "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"
        },
        "size":{
            "type":"integer",
            "example":72534,
            "description":"The size of the certificate file in bytes."
        },
        "fileName":{
            "type":"string",
            "example":"ServerCertificate.xml",
            "description":"The name of the server certificate file with extension."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response object

Body ()

Root Schema : SPICertificateResponse

Type: object

Show Source

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

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

  Example: 1
• objectNum(required): integer
  Object Number of the workstation

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "deviceNum"
    ],
    "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"
        }
    }
}

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