POST tsaservers update :id - kennethjiang/Wolke GitHub Wiki

this is a place holder as for some reason wiki will hide the first H1 line.

POST tsaservers/update/:id

Update a TSA server with a new data.

Notice there are 2 different way of implementing a POST: 1) full-update, meaning optional parameters missing in the POST will be cleared from the backend, and 2) partial-update, meaning missing parameters will remain the same value in the backend. Usually 1) is a better option as it causes less confusion, but sometimes API client can't have the full data and has to do 2)

Resource URL

http://api.netone.com/v1.0/tsaservers/update/:id.format

Parameters

name required? Description Example values
id Y TSA server ID 123
name Y Description TSA
interface Y Description *
port Y Description 9198
create_options N Description see example
verify_options N description see example
description N description description for this TSA server

Extended description

About TSA Server

TSA Server stands for Time Stamping Authority. it provides a time stamp on documents in order to provide non-repudiation in electronic communications. TSA Server is defined in RFC 3161.

Note: Here is the in-depth description of what a TSA server is, and how it can be used. This section is optional, especially if the API is for internal use only.

About Signer

If it'll help readers understand this resource, you can also include the description on other resources (in this case "Signer") involved.

Example Request

GET http://api.netone.com/v1.0/tsaservers/show/123.json

POST data:

{
  "id_str": "123",
  "name": "TSA",
  "interface": "*",
  "port": 9198,
  "create_options": [
    {
      "attach_certificate": "true",
      "signer": "C=CN,O=江苏先安科技有限公司,OU=技术支持,CN=demo.syan.com.cn,[email protected],x500UniqueIdentifier=1291970576U4D01E8105F098"
    }
  ],
  "verify_options": [
    {
      "X.509_certificate_filter": "N/A",
      "green_pass": "-"
    }
  ],
  "description": "-"
}

Response:

HTTP 200

{
  "id_str": "123",
  "name": "TSA",
  "interface": "*",
  "port": 9198,
  "create_options": [
    {
      "attach_certificate": "true",
      "signer": "C=CN,O=江苏先安科技有限公司,OU=技术支持,CN=demo.syan.com.cn,[email protected],x500UniqueIdentifier=1291970576U4D01E8105F098"
    }
  ],
  "verify_options": [
    {
      "X.509_certificate_filter": "N/A",
      "green_pass": "-"
    }
  ],
  "description": "-"
}