Variables

Gets information about all variables of a context. The response contains the information about the variables. You can use an optional parameter to include table format information in the response.

Request

GET /v1/contexts/{contextPath}/variables

Replace {contextPath} with a full context path.

For the Root Context, use server as {contextPath}.

Request Header Fields

  • Authorization — Authentication token. For more information about authentication, see Authenticating.

Request Parameters

  • includeFormat — Optional parameter. Include table format information in the response. This information is provided in the tableFormat field. Possible values: true, false.

Response Body

List of variables of a context. Each record contains information about a variable.

Response Body Fields

  • name — Variable name.

  • group — Variable group.

  • tableFormat — Information about table format.

  • defaultValue — Default value.

  • readable — If the variable is readable. Possible values: true, false.

  • writable — If the variable is writable. Possible values: true, false.

Example Request

Request:

   GET https://localhost:8443/rest/v1/contexts/users.admin.models.example/variables?includeFormat=false

Example response body JSON:

  [
        {
            "name": "granulator",
            "group": "default",
            "tableFormat": null,
            "defaultValue": [],
            "readable": true,
            "writable": true
        },
        {
            "name": "exampleTable",
            "group": "custom",
            "tableFormat": null,
            "defaultValue": [],
            "readable": true,
            "writable": true

        }

    ]

Was this page helpful?