Historie stránky

...

To get the reading of parameter value.

Request

• Urn:              /api/get

...

Metoda: POST

Klíče:

• sntp_enable
• sntp_server
• sntp_timeout
• sntp_period
• dev_sn
• test_wr_param
• ??? další

K získání hodnot všech vstupních slouží klíč "param". (když nedám žádný parametr/klíč?), 

Jak vypadá požadavek jen na některé klíče?

...

...

• Method:      POST
• Request header:  Cookie: session  - actual session value.
• Request content: json

{
      "$schema": "http://json-schema.org/draft-07/schema#",
      "paramtitle": [
"get - request",
      "type":  "sntp_enableobject",
      "properties": {
        "sntp_server",
param": {
          "type": "sntp_timeoutarray",
          "sntp_period",
items": {
            "type": "dev_snstring",
          "test_wr_param"
  "pattern": "^[a-z_][a-z0-9_]*$"
          ]}
        }

nebo
POST {      },
      "required": [
        "param":
  [] //returns all existing parameters],
      "additionalProperties": false
}

Odpověď je ve formátu json.

Meaning of json items:

    $.param:
       Array with names of configuration parameters to retrieve their values.
       An empty array causes read all parameter values.
         Type:  array
         Optional.

{
 POST {
      "statusparam": { 		[					// return unread request for reading values of specific parameters
          "sntp_timeout": "undefined"enable",
        "test_wr_param":  "accesssntp_deniedserver",
       }   "sntp_timeout",
      "value": {							// returns read parameters
 "sntp_period",
          "sntp_enable":"nodev_sn",
          "sntptest_wr_server": "ntp.cesnet.cz",param"
        ]
        "sntp_period": 2,}

//OR
      {
        "dev_snparam": "00000013"
      }[ ] 		//request for reading all values of existing parameters
      }

To get the reading of parameter value.

Request

...

Response

• Response code:
  • 200 – OK
  • 400 – Error (bad request)
  • 401 – Unauthorized
  • 500 – Server error
  • 512 - Internal application error
• Response header: Set-Cookie: session  -
actual
• Actual session value.
Request content: json
• Response type: json 

  Page_break_pdf

{
      "$schema": "http://json-schema.org/draft-07/schema#",
      "title": "get - requestresponse",
      "type": "object",
      "properties": {
        "paramstatus": {
          "type": "arrayobject",
          "itemsadditionalProperties": {
            "type": "string",
            "minLength": 1,
            "pattern": "^[a-z_][a-z0-9_]*$"
          }
        },
      },
      "requiredvalue": [{
          "type": "paramobject",
      ],
      "additionalProperties": false
}

Meaning of json items:

    $.param:
       Array with names of configuration parameters to retrieve their values.
       An empty array causes read all parameter values.
         Type:  array
         Optional.

{
            "paramtype": [			//
 request for reading values of specific parameters
          "sntp_enable"string",
          "sntp_server    "number",
          "sntp_timeout",    "boolean"
          "sntp_period"  ],
            "dev_sn"minLength": 1,
           "test_wr_param"
 "pattern": "^[a-z_][a-z0-9_]*$"
          ]}
        }

//OR
      },
      "required": {[
        "param": [ ] 			//request for reading all values of existing parameters:
      }

Response

• Response code:
  • 200 – OK
  • 500 – Server error
  • 512 - Internal application error
• Response header:  -
• Response type: json

value"
      ],
      "additionalProperties": false
}

Meaning of json items:

• $.value:
  List of readed parameters.
  Type: object
  List items are in format:

           "<parameter_name>": <parameter_value>

• $.status:
  List of unread parameter values.
  Is present only for response with response code 400 – Bad request.
  Type: object
  Optional.
  • Format of list items: "<parameter_name>": "<error_status>"
    <parameter_name> – name of reported parameter
    <error_status> – type of error.
  • Possible values:
    "undefined" – parameter not exists
    "no memory" – memory not enough
    "access denied" – parameter is not accessible
    "error" – general internal error

{
        "$schemastatus": "http://json-schema.org/draft-04/schema#",{
        "typesntp_timeout": "objectundefined",
        "propertiestest_wr_param": {"acceses_denied"
      },
      "deviceTypevalue": {
             "type"sntp_enable": "stringno",
           }
        }"sntp_server": "ntp.cesnet.cz",
        "requiredsntp_period": [2,
         "dev_sn": "deviceType00000013",
        ]
     }

{
	"deviceType": "5.1.0.0"
}