Variable (GET)

Gets information about a context variable. The response contains the information about the variable. You can use optional parameters to limit the number of fields in the output and specify an offset for fields.

Request

GET /v1/contexts/{contextPath}/variables/{variable}

Replace {contextPath} with a full context path.

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

Replace {variable} with a variable name.

Request Header Fields

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

Request Parameters

  • limit — Optional parameter. Maximum number of records to return.

  • offset — Starting offset for returned records. Optional parameter.

Response Body

List of records of a variable. Fields of the Long type are returned as JSON strings. For details, see REST/HTTP API.

Example Request

Request:

   GET https://localhost:8443/rest/v1/contexts/users.admin.models.example/variables/exampleTable?limit=2&offset=2

Example request body JSON:

   [
        {
            "name": "Room_3",
            "description": "Storage Area"
        },
        {
            "name": "Room_4",
            "description": "Boiler Room"
        }
    ]

Was this page helpful?