GET /system-ms/options/v1

This method returns all the options and the details about those options.

To get all the options and their details:

  1. Perform the authentication and login to the API. For more information, see POST /auth/login.

  2. Use GET /system-ms/options/v1 to send an HTTP GET request.

  3. Click Try it Out option.

  4. Set the parameters as listed in the following table.

    Parameter Name

    Sample Value

    Supported Value

    Description

    search

    *

    string
    Indicates the option name.
    Note:

    This parameter is mandatory.

    pageno

    0

    integer 32

    Indicates the page number.

    Default value: 1
    Note:

    This parameter is mandatory.

    pageSize

    200

    integer 32

    Indicates the number of items to include.

    Default value: 200
    Note:

    This parameter is mandatory.

    orderby

    optionid asc

    string

    Indicates the comma-separated list of fields and order to sort on. For example, optionid asc, optionName desc.

    Default value is set to ascending order when no order is specified.
    Note:

    This parameter is mandatory.

  5. Click on Execute to generate the request URL.

    Request URL:
    https://<IP_Address>:<PORT>/system-ms/options/v1?search=%2A&pageno=0&pageSize=200&orderby=optionid%20asc
    The following table lists the expected responses.

    Response Type

    Value

    Schema

    Valid Response

    200 OK

    		 
    [
  {
    "items": [
      {}
    ],
    "count": 0,
    "pageNo": 0,
    "pageSize": 0
  }
]

    Error Response

    400 Bad Request

    Not applicable

    401 Authentication Failure

    Not applicable

    403 Forbidden

    Not applicable

    404 Not found

    Not applicable
Parent topic: System Options
↑