Porovnat verze

Klíč

  • Tento řádek byl přidán.
  • Tento řádek byl odstraněn.
  • Formátování bylo změněno.

...

To get the reading of parameter value.

Request

  • Urn:              /api/get
  • Method:      POST
  • Request header:  Cookie: session  - actual session value.
  • Request content: json
Blok kódu
titleJson schema:
{
      "$schema": "http://json-schema.org/draft-07/schema#",
      "title": "get - request",
      "type": "object",
      "properties": {
        "param": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[a-z_][a-z0-9_]*$"
          }
        }
      },
      "required": [
        "param"
      ],
      "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.

Blok kódu
titleExample
{
        "param": [			// request for reading values of specific parameters
          "sntp_enable",
          "sntp_server",
          "sntp_timeout",
          "sntp_period",
          "dev_sn",
          "test_wr_param"
        ]
      }

//OR
      {
        "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

...